From f294de42d5f25f29401d726548fb1a76a8cd7459 Mon Sep 17 00:00:00 2001 From: Vanessasaurus <814322+vsoch@users.noreply.github.com> Date: Tue, 1 Jun 2021 08:46:06 -0600 Subject: [PATCH] adding notes about release (#363) * adding notes about release and also fixing bug with google build plugin Signed-off-by: vsoch --- CHANGELOG.md | 3 +++ Dockerfile | 2 +- VERSION | 2 +- docker-compose.yml | 5 +++++ docs/_docs/install/server.md | 17 +++++++++++++++++ https/docker-compose.yml | 6 ++++++ shub/plugins/google_build/urls.py | 2 +- 7 files changed, 34 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d47cb94..7f820be0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -12,6 +12,9 @@ represented by the pull requests that fixed them. Critical items to know are: ## [master](https://github.com/singularityhub/sregistry/tree/master) (master) + - update base container to Python 3.6.13 (1.1.36) + - fix google build deprecated djangorestframework function + - add notes in docs/docker-compose.yaml to pin versions - adding GitHub enterprise backend for social auth (1.1.35) - remove un-needed lib PyYaml (1.1.34) - updating Django and Django Restframework (1.1.33) diff --git a/Dockerfile b/Dockerfile index 1d0d6925..64a29fc9 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM python:3.5.7 +FROM python:3.6.13 ENV PYTHONUNBUFFERED 1 ENV DEBIAN_FRONTEND noninteractive ENV MESSAGELEVEL QUIET diff --git a/VERSION b/VERSION index 13fec672..df676e15 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -1.1.35 +1.1.36 diff --git a/docker-compose.yml b/docker-compose.yml index 45a66916..b5ce0e85 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -5,6 +5,8 @@ db: uwsgi: restart: always + + # IMPORTANT: update the tag to coincide with release version image: quay.io/vanessa/sregistry env_file: - ./.minio-env @@ -39,6 +41,7 @@ redis: image: redis:latest scheduler: + # IMPORTANT: update the tag to coincide with release version image: quay.io/vanessa/sregistry command: python /code/manage.py rqscheduler volumes: @@ -53,6 +56,8 @@ scheduler: - db worker: + + # IMPORTANT: update the tag to coincide with release version image: quay.io/vanessa/sregistry command: python /code/manage.py rqworker default volumes: diff --git a/docs/_docs/install/server.md b/docs/_docs/install/server.md index 8f50612b..f85d875f 100644 --- a/docs/_docs/install/server.md +++ b/docs/_docs/install/server.md @@ -7,6 +7,22 @@ pdf: true Before doing `docker-compose up -d` to start the containers, there are some specific things that need to be set up. +## Release Version + +If you've downloaded a [release](https://github.com/singularityhub/sregistry/releases/), +you'll want to update the `docker-compose.yaml` instances of the quay.io/vanessa/sregistry +image to be tagged with the release version that matches your clone. E.g.: + +```yaml +# Change instances of + image: quay.io/vanessa/sregistry +# to + image: quay.io/vanessa/sregistry:1.1.34 +``` + +If you have cloned master, then the current master should coincide with +latest and you don't need to do these updates. + ## Under Maintenance Page If it's ever the case that the Docker images need to be brought down for maintenance, a static fallback page should be available to notify the user. If you noticed in the [prepare_instance.sh](https://github.com/singularityhub/sregistry/blob/master/scripts/prepare_instance.sh) script, one of the things we installed is nginx (on the instance). This is because we need to use it to get proper certificates for our domain (for https). Before you do this, you might want to copy the index that we've provided to replace the default (some lame page that says welcome to Nginx!) to one that you can show when the server is undergoing maintenance. @@ -92,6 +108,7 @@ minio-images/ ``` ### Configuration + For secrets (the access and secret key that are used to create the container) we are reading in environment variables for the server in `.minio-env` that looks like this: diff --git a/https/docker-compose.yml b/https/docker-compose.yml index 93e81664..06a690a3 100644 --- a/https/docker-compose.yml +++ b/https/docker-compose.yml @@ -5,6 +5,8 @@ db: uwsgi: restart: always + + # IMPORTANT: update the tag to coincide with release version image: quay.io/vanessa/sregistry env_file: - ./.minio-env @@ -42,6 +44,8 @@ redis: image: redis:latest scheduler: + + # IMPORTANT: update the tag to coincide with release version image: quay.io/vanessa/sregistry command: python /code/manage.py rqscheduler volumes: @@ -56,6 +60,8 @@ scheduler: - db worker: + + # IMPORTANT: update the tag to coincide with release version image: quay.io/vanessa/sregistry command: python /code/manage.py rqworker default volumes: diff --git a/shub/plugins/google_build/urls.py b/shub/plugins/google_build/urls.py index 5ac09c01..96232129 100644 --- a/shub/plugins/google_build/urls.py +++ b/shub/plugins/google_build/urls.py @@ -13,7 +13,7 @@ from rest_framework import routers router = routers.DefaultRouter() -router.register(r"^build", views.RecipePushViewSet, base_name="build") # build +router.register(r"^build", views.RecipePushViewSet, basename="build") # build urlpatterns = [ url(r"^github/receive/?$", views.receive_hook, name="receive_hook"),