Skip to content

Commit

Permalink
📝 Document smilecdr upgrade image steps
Browse files Browse the repository at this point in the history
  • Loading branch information
znatty22 committed Aug 17, 2023
1 parent 5a57d3e commit 9fbb970
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,32 @@ releases website to download new images:

https://releases.smilecdr.com/

### Upgrading to a New Version

Follow these steps to upgrade to a new version of Smile CDR:

1. Download the docker image tarball from the smilecdr releases site ^
2. Create a new local image from the tarball
3. Tag and push the image to kidsfirstdrc Dockerhub so that other developers have access to the image
4. Tag and push the image to both kf-stridess and include ECRs so that future deployments
have access to the new version
5. Update the base image in the Dockerfiles (Dockerfile.includedcc, Dockerfile.kidsfirst_upgrade)
6. Push the changes to Github to ensure the deployment works

There are scripts to help with all of these steps. Here is an example of how
to upgrade to version 2023.05.R02:

```shell
# Step 2
./bin/upgrade/new_image.sh ~/Downloads/smilecdr-2023.05.R02-docker.tar.gz 2023.05.R02

# Step 3
./bin/upgrade/upgrade_dockherhub_image.sh kidsfirstdrc:smilecdr/2023.05.R02

# Step 4
./bin/upgrade/upgrade_ecr_image.sh kf-strides-smile-cdr 2023.05.R02
```

## 💻 Codebase

## Smile CDR
Expand Down

0 comments on commit 9fbb970

Please sign in to comment.