From bee463053a358b0de4650af317996c9f57bf611f Mon Sep 17 00:00:00 2001 From: Carolyn Van Slyck Date: Mon, 12 Nov 2018 15:15:58 -0600 Subject: [PATCH] Rename docker image (#909) * Rename docker image to gomods/athens * Bump chart version to match new release version * Switch from stable tag to latest tag Our docs used latest, and it's awkard when you don't have a latest tag anyway --- Makefile | 2 +- charts/proxy/Chart.yaml | 4 +-- charts/proxy/values.yaml | 10 ++++---- docs/content/configuration/authentication.md | 27 ++++++++++---------- docs/content/install/_index.md | 4 +-- docs/content/install/shared-team-instance.md | 10 ++++---- docs/content/walkthrough.md | 4 +-- init.ps1 | 9 +++---- scripts/push-docker-images.sh | 4 +-- 9 files changed, 36 insertions(+), 38 deletions(-) diff --git a/Makefile b/Makefile index ee856d57..266b0f33 100644 --- a/Makefile +++ b/Makefile @@ -39,7 +39,7 @@ docker: proxy-docker .PHONY: proxy-docker proxy-docker: - docker build -t gomods/proxy -f cmd/proxy/Dockerfile . + docker build -t gomods/athens -f cmd/proxy/Dockerfile . .PHONY: docker-push docker-push: diff --git a/charts/proxy/Chart.yaml b/charts/proxy/Chart.yaml index b9a3dea6..e2638acf 100644 --- a/charts/proxy/Chart.yaml +++ b/charts/proxy/Chart.yaml @@ -1,6 +1,6 @@ name: athens-proxy -version: 0.0.1 -appVersion: 0.0.1 +version: 0.2.0 +appVersion: 0.2.0 description: The proxy server for Go modules icon: https://bitnami.com/assets/stacks/wordpress/img/wordpress-stack-220x234.png keywords: diff --git a/charts/proxy/values.yaml b/charts/proxy/values.yaml index 23e5fa6c..434452e8 100644 --- a/charts/proxy/values.yaml +++ b/charts/proxy/values.yaml @@ -1,8 +1,8 @@ replicaCount: 1 image: registry: docker.io - repository: gomods/proxy - tag: v0.1.0 + repository: gomods/athens + tag: v0.2.0 ## Specify a imagePullPolicy ## Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent' ## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images @@ -25,9 +25,9 @@ ingress: annotations: # Provide an array of values for the ingress host mapping hosts: - # Provide a base64 encoded cert for TLS use - tls: - + # Provide a base64 encoded cert for TLS use + tls: + storage: type: disk disk: diff --git a/docs/content/configuration/authentication.md b/docs/content/configuration/authentication.md index 4b607ab0..a842c058 100644 --- a/docs/content/configuration/authentication.md +++ b/docs/content/configuration/authentication.md @@ -8,12 +8,12 @@ weight: 1 ## SVN private repositories -1. Subversion creates an authentication structure in - +1. Subversion creates an authentication structure in + ~/.subversion/auth/svn.simple/ 2. In order to properly create the authentication file for your SVN servers you will need to authenticate to them and let svn build out the proper hashed files. - + $ svn list http:///svn/ Authentication realm: Subversion Repository Username: test @@ -34,7 +34,7 @@ weight: 1 --name athens-proxy \ --restart always \ -p 3000:3000 \ - gomods/proxy:latest + gomods/athens:latest ``` **PowerShell** @@ -50,7 +50,7 @@ weight: 1 --name athens-proxy ` --restart always ` -p 3000:3000 ` - gomods/proxy:latest + gomods/athens:latest ``` ## Bazaar(bzr) private repositories @@ -58,18 +58,18 @@ weight: 1 1. Bazaaar config files are located in - Unix - + ~/.bazaar/ - Windows - + C:\Documents and Settings\\Application Data\Bazaar\2.0 - You can check your location using - + bzr version 2. There are 3 typical configuration files - + - bazaar.conf - default config options - locations.conf @@ -83,12 +83,12 @@ weight: 1 - [header] this denotes a section header - section options reside in a header section and contain an option name an equals sign and a value - EXAMPLE: - + [DEFAULT] email = John Doe 4. Authentication Configuration - + Allows one to specify credentials for remote servers. This can be used for all the supported transports and any part of bzr that requires authentication(smtp for example). The syntax obeys the same rules as the others except for the option policies which don't apply. @@ -157,7 +157,7 @@ weight: 1 --name athens-proxy \ --restart always \ -p 3000:3000 \ - gomods/proxy:latest + gomods/athens:latest ``` **PowerShell** @@ -173,6 +173,5 @@ weight: 1 --name athens-proxy ` --restart always ` -p 3000:3000 ` - gomods/proxy:latest + gomods/athens:latest ``` - diff --git a/docs/content/install/_index.md b/docs/content/install/_index.md index 76d739b9..fbb78b72 100644 --- a/docs/content/install/_index.md +++ b/docs/content/install/_index.md @@ -17,7 +17,7 @@ We feel that Athens should keep the community federated and open, and nobody sho To make sure it's easy to install, we try to provide as many ways as possible to install and run Athens: -- It's written in Go, so we provide a self-contained binary. You can configure and run the binary on your machine(s) +- It's written in Go, so we provide a self-contained binary. You can configure and run the binary on your machine(s) - Instructions on how to run directly from the binary are coming soon -- We provide a [Docker image](https://hub.docker.com/r/gomods/proxy/) and [instructions on how to run it](./shared-team-instance) +- We provide a [Docker image](https://hub.docker.com/r/gomods/athens/) and [instructions on how to run it](./shared-team-instance) - We provide [Kubernetes](https://kubernetes.io) [Helm Charts](https://helm.sh) with [instructions on how to run Athens on Kubernetes](./install-on-kubernetes) diff --git a/docs/content/install/shared-team-instance.md b/docs/content/install/shared-team-instance.md index 8ee47294..f2ab6044 100644 --- a/docs/content/install/shared-team-instance.md +++ b/docs/content/install/shared-team-instance.md @@ -26,7 +26,7 @@ docker run -d -v $ATHENS_STORAGE:/var/lib/athens \ --name athens-proxy \ --restart always \ -p 3000:3000 \ - gomods/proxy:latest + gomods/athens:latest ``` **PowerShell** @@ -39,7 +39,7 @@ docker run -d -v "$($env:ATHENS-STORAGE):/var/lib/athens" ` --name athens-proxy ` --restart always ` -p 3000:3000 ` - gomods/proxy:latest + gomods/athens:latest ``` Note: if you have not previously mounted this drive with Docker for Windows, you may be prompted to allow access @@ -49,7 +49,7 @@ Athens should now be running as a Docker container with the local directory, `at ```console $ docker ps CONTAINER ID IMAGE COMMAND PORTS NAMES -f0429b81a4f9 gomods/proxy:latest "/bin/app" 0.0.0.0:3000->3000/tcp athens-proxy +f0429b81a4f9 gomods/athens:latest "/bin/app" 0.0.0.0:3000->3000/tcp athens-proxy ``` Now, we can use Athens from any development machine that has Go 1.11 installed. To verify this, try the following example: @@ -142,7 +142,7 @@ docker run -d -v $ATHENS_STORAGE:/var/lib/athens \ --name athens-proxy \ --restart always \ -p 3000:3000 \ - gomods/proxy:latest + gomods/athens:latest ``` **PowerShell** @@ -153,7 +153,7 @@ docker run -d -v "$($env:ATHENS-STORAGE):/var/lib/athens" ` --name athens-proxy ` --restart always ` -p 3000:3000 ` - gomods/proxy:latest + gomods/athens:latest ``` When we re-run our Go example, the Go cli will again download module from Athens. Athens, however, will not need to retrieve the module. It will be served from the Athens on-disk storage. diff --git a/docs/content/walkthrough.md b/docs/content/walkthrough.md index 8665ace6..87c4f842 100644 --- a/docs/content/walkthrough.md +++ b/docs/content/walkthrough.md @@ -101,7 +101,7 @@ docker run -d -v $ATHENS_STORAGE:/var/lib/athens \ --name athens-proxy \ --restart always \ -p 3000:3000 \ - gomods/proxy:latest + gomods/athens:latest ``` **PowerShell** @@ -114,7 +114,7 @@ docker run -d -v "$($env:ATHENS-STORAGE):/var/lib/athens" ` --name athens-proxy ` --restart always ` -p 3000:3000 ` - gomods/proxy:latest + gomods/athens:latest ``` Next, you will need to enable the [Go Modules](https://github.com/golang/go/wiki/Modules) diff --git a/init.ps1 b/init.ps1 index f1e708cc..f0d00531 100644 --- a/init.ps1 +++ b/init.ps1 @@ -64,7 +64,7 @@ if ($build.IsPresent) { finally { Pop-Location } - + finally { Pop-Location } @@ -76,7 +76,7 @@ if ($run.IsPresent) { } if ($docs.IsPresent) { - Set-Location docs + Set-Location docs & hugo } @@ -121,12 +121,12 @@ if ($test_e2e.IsPresent) { } if ($docker.IsPresent) { - & docker build -t gomods/proxy -f cmd/proxy/Dockerfile . + & docker build -t gomods/athens -f cmd/proxy/Dockerfile . } if ($proxy_docker.IsPresent) { - & docker build -t gomods/proxy -f cmd/proxy/Dockerfile . + & docker build -t gomods/athens -f cmd/proxy/Dockerfile . } if ($bench.IsPresent) { @@ -136,4 +136,3 @@ if ($bench.IsPresent) { if ($down.IsPresent) { & docker-compose -p athensdev down -v } - diff --git a/scripts/push-docker-images.sh b/scripts/push-docker-images.sh index 007d734d..6e652e0c 100755 --- a/scripts/push-docker-images.sh +++ b/scripts/push-docker-images.sh @@ -18,11 +18,11 @@ else BRANCH=${BRANCH:-$(git symbolic-ref -q --short HEAD || echo "")} fi -# MUTABLE_TAG is the docker image tag that we will reuse between pushes, it is not a stable tag like a commit hash or tag. +# MUTABLE_TAG is the docker image tag that we will reuse between pushes, it is not an immutable tag like a commit hash or tag. if [[ "${MUTABLE_TAG:-}" == "" ]]; then # tagged builds if [[ "$VERSION" =~ ^v[0-9]+\.[0-9]+\.[0-9]+ ]]; then - MUTABLE_TAG="stable" + MUTABLE_TAG="latest" # master build elif [[ "$BRANCH" == "master" ]]; then MUTABLE_TAG="canary"