Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Please follow below guide after the tech team has cut the new release. You need to be authorized to push the image to docker.sunet.se, see this.

Build thiss-js

  1. git clone https://github.com/TheIdentitySelector/thiss-js
  2. git checkout <version-to-be-released>
  3. make docker && make docker_push_sunet 

...

  1. sunet

Build thiss-mdq

  1.  git clone git@github.com:TheIdentitySelector/thiss-mdq.git
  2.   make

Beta deployment 

Frontend (use.thiss.io)

...

To deploy <version> to beta (use.thiss.io)

  1. Clone the git repository in your computer (git@github.com:TheIdentitySelector/thiss-ops.git)
  2. Open global/overlay/etc/hiera/data/common.yaml, check the 'max-age' under 'cache_control_beta'. If the current s-max age is 2 days or 172800 seconds, you need to change it to 10 hours, two days before the deployment. If it is one day, you need to change it to 10 hours exactly 1 day before. We need to do it so the old cache gets cleared from non-fastly cache nodes and new files are requested from our backend during the deployment.
  3. Wait as long as the old 's-max-age' and then proceed to the next step. You can even check in the 'developer tools' of your browser (e.g. Chrome, Firefox) that the response headers have the new s-maxage of 10 hours. You can try by using https://demo.beta.seamlessaccess.org/ 
  4. Update the ds_version_beta in global/overlay/etc/hiera/data/common.yaml.

...

  1. Run git add global/overlay/etc/hiera/data/common.yaml and git commitYou should ofcourse have right to commit in the repository.
  2. Run the script thiss-ops/bump-tag afterwards.
  3. To verify that the new version is installed, log in to the servers static-1.thiss.io and , static-2.thiss.io, static-1.aws2.thiss.io & static-2.aws2.sthiss.io and enter 'run-cosmo -v'. 
  4. Restart the service by running the command service sunet-thiss_js restart.
  5. You You can check the status by running the command service dockersunet-thiss_js status.
  6. You can run  curl -k https://localhost/manifest.json to see that it shows current version and no errors.
  7. You can also enter 'docker ps' in order to see if the new version is present on docker image tag.
  8. We may have to do more than one version upgrade to make it backward compatible, check https://github.com/TheIdentitySelector/thiss-js/blob/staging/RELEASE.md
  9. Check that the login works using demo.beta.seamlessaccess.org. You can check the transaction check & page speed in Pingdom after each upgrade. Page speed shows the response headers and other information for each file loaded from https://use.thiss.io.
  10. It is also good to check the HIT ratio (observability > service overview) and origin latency under CDN services from Fastly GUI for the service 'use.thiss.io'. Chek that the HIT ratio is high enough, should be around 98 to 99 percent, latency is way below 5 seconds.
  11. After the verification step is done, everything looks good and open global/overlay/etc/hiera/data/common.yaml and change 'cache_control_beta to original value after 10 hours have passed.

...

In order to rollback simply downgrade the version in cosmos-rules.yaml and follow the exact steps for committing and pushing the the changes to the git remote repo.

Backend (md.thiss.io)

  1. Clone the git repository in your computer (git@github.com:TheIdentitySelector/thiss-ops.git)
  2. Update the version under thiss::mdq for both 'md-1.thiss.io' and 'md-2.thiss.io'

...

  1. Do git add global/overlay/etc/puppet/cosmos-rules.yaml and git commit. You should ofcourse have right to commit in the repository.
  2. Run the script thiss-ops/bump-tag afterwards.
  3. To verify that the new version is installed, log in to the servers md-1.thiss.io and md-2.thiss.io and enter 'run-cosmo -v'. You can check
  4. Restart the
  5. status
  6. service by running the
  7. command service docker-thiss_mdq status
  8. command service sunet-thiss-mdq restart.
  9. You can check the status by running the command service sunet-thiss-mdq status.
  10. You can run  curl -k http://localhost/ to see that it shows right version, metadata information and no errors.
  11. You can also enter 'docker ps' in order to see if the new version is present on docker image tag. 

...

Simply undo the  changes and go back to old changes and commit them in thiss-ops repository.

Production deployment

Frontend (service.seamlessaccess.org)

Frontend

The current whitelist needs to be checked with the master list before each deploy. Note that use.thiss.io does not do whitelisting which means the WHITELIST variable is not set.

To deploy <version> to production (service.seamlessaccess.org)

  1. Clone the git repository in your computer (git@github.com:TheIdentitySelector/thiss-ops.git)
  2. Open global/overlay/etc/hiera/data/common.yaml and check that the whitelist is right or change it if needed.


    Warning
    titleWhitelisting

    It is important to set the WHITELIST environment variable to the comma-separated list of the current whitelisted domains before deploying. Ask Marina or Leif to verify the list. The list is updated here Seamless Access Configuration Parameters.


  3. Open global/overlay/etc/hiera/data/common.yaml, check the 's-maxage' under 'cache_control_prod. If the current s-max age is 2 days or 172800 seconds, you need to change it to 10 hours, two days before the deployment. If it is one day, you need to change it to 10 hours exactly 1 day before. We need to do it so the old cache gets cleared from non-fastly cache nodes and new files are requested from our backend during the deployment.
  4. It is good to see that backends are not overloaded, you can check the HIT ratio (observability > service overview) and origin latency under CDN services from Fastly GUI for the service 'service.seamlessaccess.org'.
  5. Keep an eye on the transaction check in pingodm that it is not failing after lowering the s-maxage.
  6. Wait as long as the old 's-maxage' and then proceed to the next step. You can even check in the 'developer tools' of your browser (e.g. Chrome, Firefox) that the response headers have the new s-maxage of 10 hours. You can try by using https://demo.seamlessaccess.org/ 
  7. Update the ds_version_prod in global/overlay/etc/hiera/data/common.yaml.


    Code Block
    languagebash
    ds_version_prod: '2.1.51'
    cache_control_prod: 'public, max-age=36000, must-revalidate, s-maxage=172800, proxy-revalidate'


  8. Run git add global/overlay/etc/hiera/data/common.yaml and git commitYou should ofcourse have right to commit in the repositoryRun git add global/overlay/etc/hiera/data/common.yamlas well if whitelist is changed. You should ofcourse have right to commit in the repository.
  9. Run the script thiss-ops/bump-tagafterwards.
  10. To verify that the new version is installed, log in to below servers and enter 'run-cosmo -v'. 


    static-1.aws1.geant.eu.seamlessaccess.org

    static-1.aws2.geant.eu.seamlessaccess.org

    static-1.ntx.sunet.eu.seamlessaccess.org

    static-1.se-east.sunet.eu.seamlessaccess.org (have to run service sunet-thiss_js restart manually)

    static-2.aws1.geant.eu.seamlessaccess.org

    static-2.aws2.geant.eu.seamlessaccess.org

    static-2.ntx.sunet.eu.seamlessaccess.org

    static-2.se-east.sunet.eu.seamlessaccess.org

    You can check the
  11. Restart the service by running the command service sunet-thiss_js restart.
  12. You can check the status by running the command service
  13. docker
  14. sunet-thiss_js status.
  15. You can run  curl -k https://localhost/manifest.json to see that it shows current version and no errors.
  16. You can also enter 'docker ps' in order to see if the new version is present on docker image tag. 
  17. We may have to do more than one version upgrade to make it backward compatible, check https://github.com/TheIdentitySelector/thiss-js/blob/staging/RELEASE.md
  18. Check that the login works using demo.seamlessaccess.org. You can check the transaction check & page speed in Pingdom after each upgrade. Page speed shows the response headers and other information for each file loaded from https://service.seamlessaccess.org.
  19. It is also good to check the HIT ratio (observability > service overview) and origin latency under CDN services from Fastly GUI for the service 'service.seamlessaccess.org'. Chek that the HIT ratio is high enough, should be around 98 to 99 percent and latency is way below 5 seconds.                                                              
  20. After the verification step is done, everything looks good and few hours have passed, open global/overlay/etc/hiera/data/common.yaml and change 'max-age' under 'cache_control_prod' to original value.

...

  1. Clone the git repository in your computer (git@github.com:TheIdentitySelector/thiss-ops.git)
  2. Open global/overlay/etc/hiera/data/common.yaml and check that the whitelist is right or change it if needed.


    Warning
    titleWhitelisting

    It is important to set the WHITELIST environment variable to the comma-separated list of the current whitelisted domains before deploying. Ask Marina or Leif to verify the list. The list is updated here Seamless Access Configuration Parameters.


  3. Do git add global/overlay/etc/hiera/data/common.yaml as well if whitelist is changed. You should ofcourse have right to commit in the repository.
  4. Run the script thiss-ops/bump-tag afterwards.
  5. Log in to below servers and enter 'run-cosmo -v'. 'thiss-js' docker container should get restarted.


    static-1.aws1.geant.eu.seamlessaccess.org

    static-1.aws2.geant.eu.seamlessaccess.org

    static-1.ntx.sunet.eu.seamlessaccess.org

    static-1.se-east.sunet.eu.seamlessaccess.org

    static-2.aws1.geant.eu.seamlessaccess.org

    static-2.aws2.geant.eu.seamlessaccess.org

    static-2.ntx.sunet.eu.seamlessaccess.org

    static-2.se-east.sunet.eu.seamlessaccess.org

  6. You can check the status by running the command service docker-thiss_js status.
  7. Log into Fastly management web GUI https://manage.fastly.com/ and purge all cache for the service 'service.seamlessaccess.org' otherwise it will take the amount of seconds set in 's-maxage' in the static servers for the Fastly servers to fetch the updated JS page.

Verification

Visit https://service.seamlessaccess.org/ps.js should contain the new whitelisted domain. in browser and open the Developers tab. Find out the 'https://service.seamlessaccess.org/ps_<contetn hash>.js' link from the Network tab. That link should contain the new whitelisted domain(s). It may take a while to get updated depending on the age of the cache in your browser.

Image Added

It is also good to check that the service is working by visiting https://demo.seamlessaccess.org.

Backend (md.seamlessaccess.org)

  1. Clone the git repository in your computer (git@github.com:TheIdentitySelector/thiss-ops.git)
  2. Update the version under thiss::mdq for each site (ntx, se-east, aws1 and aws2)


    Code Block
    '^md-[0-9]\.ntx\.sunet\.eu\.seamlessaccess\.org$':
       thiss::dockerhost:
       thiss::mdq:
          version: 1.3.2
          src: https://meta.ntx.sunet.eu.seamlessaccess.org/metadata.json
          base_url: https://md.seamlessaccess.org
          post: /usr/sbin/service docker-thiss_mdq restart


  3. Do git add global/overlay/etc/puppet/cosmos-rules.yaml and git commit. You should ofcourse have right to commit in the repository.
  4. Run the script thiss-ops/bump-tag afterwards.
  5. To verify that the new version is installed, log in to below servers and enter 'run-cosmo -v'. 

    md-1.aws1.geant.eu.seamlessaccess.org

    md-1.aws2.geant.eu.seamlessaccess.org

    md-1.ntx.sunet.eu.seamlessaccess.org

    md-1.se-east.sunet.eu.seamlessaccess.org

    md-2.aws1.geant.eu.seamlessaccess.org

    md-2.aws2.geant.eu.seamlessaccess.org

    md-2.ntx.sunet.eu.seamlessaccess.org

    md-2.se-east.sunet.eu.seamlessaccess.org

  6. Restart the service by running the command service sunet-thiss-mdq restart.
  7. You can check the status by running the command service
  8. docker
  9. sunet-thiss
  10. _
  11. -mdq status.
  12. You can run  curl -k http://localhost/ to see that it shows right version, metadata information and no errors.
  13. You can also enter 'docker ps' in order to see if the new version is present on docker image tag. 

...