Updated documentation to remove hardcoded versions

Updated the documentation to remove hardcoded versions for COmanage Registry and instead point to the COmanage Registry Release History wiki page along with a sed command to replace COMANAGE_REGISTRY_VERSION in the compose file.
docker · Jul 17, 2018 · b65387a · b65387a
1 parent c0d15bb
commit b65387a
Show file tree

Hide file tree

Showing 7 changed files with 99 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -49,10 +49,15 @@ git clone https://github.com/Internet2/comanage-registry-docker.git
 cd comanage-registry-docker
 ```
 
-* Define `COMANAGE_REGISTRY_VERSION`. Currently we recommend
+* Define the shell variable `COMANAGE_REGISTRY_VERSION` to be the version
+of COmanage Registry you want to deploy. See the
+[COmanage Registry Release History](https://spaces.internet2.edu/display/COmanage/Release+History)
+wiki page for the list of releases. We recommend using the latest release.
+
+Here is an example (but please check the wiki page for the latest release number):
 
 ```
-export COMANAGE_REGISTRY_VERSION=3.1.0
+export COMANAGE_REGISTRY_VERSION=3.1.1
 ```
 
 * Build a local image for COmanage Registry:
@@ -70,7 +75,7 @@ pushd comanage-registry-postgres
 docker build -t comanage-registry-postgres .
 popd
 ```
-* Create a docker-compose.yml file:
+* Create a template docker-compose.yml file:
 ```
 version: '3.1'
 
@@ -80,12 +85,19 @@ services:
         image: comanage-registry-postgres
 
     comanage-registry:
-        image: comanage-registry:3.1.0-basic-auth
+        image: comanage-registry:COMANAGE_REGISTRY_VERSION-basic-auth
         ports:
             - "80:80"
             - "443:443"
 ```
 
+* Use sed to set the COmanage Registry version for the image in the 
+docker-compose.yml file:
+
+```
+sed -i s/COMANAGE_REGISTRY_VERSION/$COMANAGE_REGISTRY_VERSION/ docker-compose.yml
+```
+
 * Start the services:
 ```
 docker-compose up -d

diff --git a/docs/advanced-configuration.md b/docs/advanced-configuration.md
@@ -217,7 +217,7 @@ services:
             - MYSQL_PASSWORD_FILE=/run/secrets/mysql_password
 
     comanage-registry:
-        image: comanage-registry:hotfix-2.0.x-basic-auth
+        image: comanage-registry:3.1.1-basic-auth
         environment:
             - COMANAGE_REGISTRY_DATASOURCE=Database/Mysql
             - COMANAGE_REGISTRY_DATABASE_USER_PASSWORD_FILE=/run/secrets/mysql_password
@@ -281,7 +281,7 @@ services:
             - "389:389"
 
     comanage-registry:
-        image: comanage-registry:hotfix-2.0.x-basic-auth
+        image: comanage-registry:3.1.1-basic-auth
         environment:
             - COMANAGE_REGISTRY_DATASOURCE=Database/Mysql
             - COMANAGE_REGISTRY_DATABASE_USER_PASSWORD_FILE=/run/secrets/mysql_password
@@ -316,7 +316,7 @@ services:
             - MYSQL_PASSWORD_FILE=/run/secrets/mysql_password
 
     comanage-registry:
-        image: comanage-registry:hotfix-2.0.x-basic-auth
+        image: comanage-registry:3.1.1-basic-auth
         environment:
             - COMANAGE_REGISTRY_DATASOURCE=Database/Mysql
             - COMANAGE_REGISTRY_DATABASE_USER_PASSWORD_FILE=/run/secrets/mysql_password

diff --git a/docs/basic-auth-mariadb-persist.md b/docs/basic-auth-mariadb-persist.md
@@ -22,10 +22,15 @@ limitations under the License.
 # COmanage Registry Docker
 ## With Basic Authentication, MariaDB, and persisted data
 
-* Define `COMANAGE_REGISTRY_VERSION`. Currently we recommend
+* Define the shell variable `COMANAGE_REGISTRY_VERSION` to be the version
+of COmanage Registry you want to deploy. See the
+[COmanage Registry Release History](https://spaces.internet2.edu/display/COmanage/Release+History)
+wiki page for the list of releases. We recommend using the latest release.
+
+Here is an example (but please check the wiki page for the latest release number):
 
 ```
-export COMANAGE_REGISTRY_VERSION=hotfix-2.0.x
+export COMANAGE_REGISTRY_VERSION=3.1.1
 ```
 
 * Build a local image for COmanage Registry if you have not already:
@@ -47,7 +52,7 @@ mkdir -p /docker/var/lib/mysql
 mkdir -p /docker/srv/comanage-registry/local
 ```
 
-* Create a docker-compose.yml file. Be sure to replace the password examples
+* Create a docker-compose.yml template file. Be sure to replace the password examples
 below with your own choices.
 ```
 version: '3.1'
@@ -65,7 +70,7 @@ services:
             - MYSQL_PASSWORD=vy4O6XF58gl1fMpf6rRg
 
     comanage-registry:
-        image: comanage-registry:hotfix-2.0.x-basic-auth
+        image: comanage-registry:COMANAGE_REGISTRY_VERSION-basic-auth
         volumes:
             - /docker/srv/comanage-registry/local:/srv/comanage-registry/local
         environment:
@@ -77,6 +82,13 @@ services:
             - "443:443"
 ```
 
+* Use sed to set the COmanage Registry version for the image in the 
+docker-compose.yml file:
+
+```
+sed -i s/COMANAGE_REGISTRY_VERSION/$COMANAGE_REGISTRY_VERSION/ docker-compose.yml
+```
+
 * Start the services:
 ```
 docker-compose up -d

diff --git a/docs/basic-auth-postgres-persist.md b/docs/basic-auth-postgres-persist.md
@@ -22,10 +22,15 @@ limitations under the License.
 # COmanage Registry Docker
 ## With Basic Authentication, PostgreSQL, and persisted data
 
-* Define `COMANAGE_REGISTRY_VERSION`. Currently we recommend
+* Define the shell variable `COMANAGE_REGISTRY_VERSION` to be the version
+of COmanage Registry you want to deploy. See the
+[COmanage Registry Release History](https://spaces.internet2.edu/display/COmanage/Release+History)
+wiki page for the list of releases. We recommend using the latest release.
+
+Here is an example (but please check the wiki page for the latest release number):
 
 ```
-export COMANAGE_REGISTRY_VERSION=3.1.0
+export COMANAGE_REGISTRY_VERSION=3.1.1
 ```
 
 * Build a local image for COmanage Registry if you have not already:
@@ -51,7 +56,7 @@ mkdir -p /docker/var/lib/postgresql/data
 mkdir -p /docker/srv/comanage-registry/local
 ```
 
-* Create a docker-compose.yml file that mounts the directories you created
+* Create a template docker-compose.yml file that mounts the directories you created
 as volumes in the database container:
 ```
 version: '3.1'
@@ -64,14 +69,21 @@ services:
             - /docker/var/lib/postgresql/data:/var/lib/postgresql/data
 
     comanage-registry:
-        image: comanage-registry:3.1.0-basic-auth
+        image: comanage-registry:COMANAGE_REGISTRY_VERSION-basic-auth
         volumes:
             - /docker/srv/comanage-registry/local:/srv/comanage-registry/local
         ports:
             - "80:80"
             - "443:443"
 ```
 
+* Use sed to set the COmanage Registry version for the image in the 
+docker-compose.yml file:
+
+```
+sed -i s/COMANAGE_REGISTRY_VERSION/$COMANAGE_REGISTRY_VERSION/ docker-compose.yml
+```
+
 * Start the services:
 ```
 docker-compose up -d

diff --git a/docs/mod-auth-oidc-mariadb-stacks.md b/docs/mod-auth-oidc-mariadb-stacks.md
@@ -29,10 +29,15 @@ This recipe uses Docker service stacks, swarm, and secrets rather than docker-co
 
 ## Recipe
 
-* Define `COMANAGE_REGISTRY_VERSION`. Currently we recommend
+* Define the shell variable `COMANAGE_REGISTRY_VERSION` to be the version
+of COmanage Registry you want to deploy. See the
+[COmanage Registry Release History](https://spaces.internet2.edu/display/COmanage/Release+History)
+wiki page for the list of releases. We recommend using the latest release.
+
+Here is an example (but please check the wiki page for the latest release number):
 
 ```
-export COMANAGE_REGISTRY_VERSION=hotfix-2.0.x
+export COMANAGE_REGISTRY_VERSION=3.1.1
 ```
 
 * Build a local image for COmanage Registry if you have not already:
@@ -136,7 +141,7 @@ docker secret create https_cert_file fullchain.pem
 docker secret create https_privkey_file privkey.pem
 ```
 
-* Create a docker-compose.yml by adjusting the example below:
+* Create a template docker-compose.yml by adjusting the example below:
 
 ```
 version: '3.1'
@@ -186,7 +191,7 @@ services:
             replicas: 1
 
     comanage-registry:
-        image: comanage-registry:hotfix-2.0.x
+        image: comanage-registry:COMANAGE_REGISTRY_VERSION-mod-auth-openidc
         volumes:
             - /srv/docker/srv/comanage-registry/local:/srv/comanage-registry/local
         environment:
@@ -248,6 +253,13 @@ ID token from the OP that authenticates the first platform administrator.
 By default mod\_auth\_openidc will expect to consume that identifier
 from the sub claim asserted for the admin by the OP.
 
+* Use sed to set the COmanage Registry version for the image in the 
+docker-compose.yml file:
+
+```
+sed -i s/COMANAGE_REGISTRY_VERSION/$COMANAGE_REGISTRY_VERSION/ docker-compose.yml
+```
+
 Bring up the services using docker stack deploy:
 
 ```

diff --git a/docs/openldap-slapd.md b/docs/openldap-slapd.md
@@ -22,10 +22,15 @@ limitations under the License.
 # COmanage Registry Docker
 ## With Basic Authentication, PostgreSQL, and OpenLDAP slapd
 
-* Define `COMANAGE_REGISTRY_VERSION`. Currently we recommend
+* Define the shell variable `COMANAGE_REGISTRY_VERSION` to be the version
+of COmanage Registry you want to deploy. See the
+[COmanage Registry Release History](https://spaces.internet2.edu/display/COmanage/Release+History)
+wiki page for the list of releases. We recommend using the latest release.
+
+Here is an example (but please check the wiki page for the latest release number):
 
 ```
-export COMANAGE_REGISTRY_VERSION=hotfix-2.0.x
+export COMANAGE_REGISTRY_VERSION=3.1.1
 ```
 
 * Build a local image for COmanage Registry if you have not already:
@@ -63,7 +68,7 @@ mkdir -p /docker/var/lib/ldap
 mkdir -p /docker/etc/ldap/slapd.d
 ```
 
-* Create a docker-compose.yml file that mounts the directories you created
+* Create a template docker-compose.yml file that mounts the directories you created
 as volumes in the database container:
 ```
 version: '3.1'
@@ -84,14 +89,21 @@ services:
             - "389:389"
 
     comanage-registry:
-        image: comanage-registry:hotfix-2.0.x-basic-auth
+        image: comanage-registry:COMANAGE_REGISTRY_VERSION-basic-auth
         volumes:
             - /docker/srv/comanage-registry/local:/srv/comanage-registry/local
         ports:
             - "80:80"
             - "443:443"
 ```
 
+* Use sed to set the COmanage Registry version for the image in the 
+docker-compose.yml file:
+
+```
+sed -i s/COMANAGE_REGISTRY_VERSION/$COMANAGE_REGISTRY_VERSION/ docker-compose.yml
+```
+
 * Start the services:
 ```
 docker-compose up -d

diff --git a/docs/shibboleth-sp-postgres-compose.md b/docs/shibboleth-sp-postgres-compose.md
@@ -35,10 +35,15 @@ docker-compose version 1.13.0, build 1719ceb
 
 ## Recipe
 
-* Define `COMANAGE_REGISTRY_VERSION`. Currently we recommend
+* Define the shell variable `COMANAGE_REGISTRY_VERSION` to be the version
+of COmanage Registry you want to deploy. See the
+[COmanage Registry Release History](https://spaces.internet2.edu/display/COmanage/Release+History)
+wiki page for the list of releases. We recommend using the latest release.
+
+Here is an example (but please check the wiki page for the latest release number):
 
 ```
-export COMANAGE_REGISTRY_VERSION=3.1.0
+export COMANAGE_REGISTRY_VERSION=3.1.1
 ```
 
 * Build a local image for COmanage Registry if you have not already (building the
@@ -149,7 +154,7 @@ echo '<!--<MetadataProvider type="XML" file="partner-metadata.xml"/>-->' \
     > /docker/run/secrets/shibboleth_sp_metadata_provider_xml
 ```
 
-* Create a docker-compose.yml by adjusting the example below:
+* Create a template docker-compose.yml by adjusting the example below:
 
 ```
 version: '3.1'
@@ -183,7 +188,7 @@ services:
             - "389:389"
 
     comanage-registry:
-        image: comanage-registry:3.1.0-shibboleth-sp
+        image: comanage-registry:COMANAGE_REGISTRY_VERSION-shibboleth-sp
         volumes:
             - /docker/srv/comanage-registry/local:/srv/comanage-registry/local
             - /docker/run/secrets:/run/secrets
@@ -211,6 +216,13 @@ assertion from the IdP that authenticates the first platform administrator.
 By default the Shibboleth SP will expect to consume that identifier
 from the eduPersonPrincipalName attribute asserted for the admin by the IdP.
 
+* Use sed to set the COmanage Registry version for the image in the 
+docker-compose.yml file:
+
+```
+sed -i s/COMANAGE_REGISTRY_VERSION/$COMANAGE_REGISTRY_VERSION/ docker-compose.yml
+```
+
 Bring up the services using docker-compose:
 
 ```