Skip to content

Commit

Permalink
adding notes about release (#363)
Browse files Browse the repository at this point in the history
* adding notes about release
and also fixing bug with google build plugin

Signed-off-by: vsoch <[email protected]>
  • Loading branch information
vsoch authored Jun 1, 2021
1 parent 481cde7 commit f294de4
Show file tree
Hide file tree
Showing 7 changed files with 34 additions and 3 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
FROM python:3.5.7
FROM python:3.6.13
ENV PYTHONUNBUFFERED 1
ENV DEBIAN_FRONTEND noninteractive
ENV MESSAGELEVEL QUIET
Expand Down
2 changes: 1 addition & 1 deletion VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.1.35
1.1.36
5 changes: 5 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down
17 changes: 17 additions & 0 deletions docs/_docs/install/server.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand Down
6 changes: 6 additions & 0 deletions https/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion shub/plugins/google_build/urls.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"),
Expand Down

0 comments on commit f294de4

Please sign in to comment.