diff --git a/README.md b/README.md index 15194c264229a0fe6680fd32a00f24a02ca52dca..d2802160eae140183f0ea1267064df96876aba71 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,12 @@ <!-- START doctoc generated TOC please keep comment here to allow auto update --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> -**Stanford OpenLDAP in Container** +*Stanford OpenLDAP in Container* - [Stanford OpenLDAP in Container](#stanford-openldap-in-container) - [Get and setup personal drone token](#get-and-setup-personal-drone-token) - [Turn on the ci job defined in .drone.yml](#turn-on-the-ci-job-defined-in-droneyml) -- [Update ldap image](#update-ldap-image) - - [Verify the configuration env defined in env.sh, make sure all the key files are accessible](#verify-the-configuration-env-defined-in-envsh-make-sure-all-the-key-files-are-accessible) - - [Manual push to Google container registry](#manual-push-to-google-container-registry) +- [Update OpenLdap image](#update-openldap-image) + - [Manual push to Google container registry](#manual-push-to-google-container-registry) <!-- END doctoc generated TOC please keep comment here to allow auto update --> @@ -15,35 +14,38 @@ # Stanford OpenLDAP in Container -This repository contains instructions how to build and publish docker-ldap image to +This repository contains instructions on how to build and publish docker-openldap image to Google Container Registry. -This repo supports [DroneCI](https://drone.svc.stanford.edu/authnz/docker-openldap). +This repository supports [DroneCI](https://drone.svc.stanford.edu/authnz/docker-openldap). # Get and setup personal drone token -Drone CLI requires access token to talk to drone server. +Drone CLI requires access token to authenticate to a drone server. -Please get your [personal token](https://drone.svc.stanford.edu/account/token), -and save the the token to ${HOME}/.drone-token file. +You can get your [personal token](https://drone.svc.stanford.edu/account/token), +and save the token to ${HOME}/.drone-token file. -_NOTE_: Do not add newline at the end of the token. +_NOTE_: Make sure you do not have newline at the end of the token file. You will get authentication failure. # Turn on the ci job defined in .drone.yml -NOTE: This will setup the hook for CI trigger. This only needs to be done once. You probably don't +NOTE: This will setup the hook for CI trigger. It needs to be done only once. You don't need to run this if it's been setup already. -``` +```console $ make drone-setup +... ``` See .drone.yml for build steps and triggers. -# Update openldap image +# Update OpenLdap image + +To upgrade software version and base image, edit build.sh, env.sh to change `OPENLDAP_VERSION`, and edit `.drone.yml` to change tag. If you make changes to the repository, you can test build manually. If the build is successful, -then commit and push changes to the docker-ldap repository. It will trigger CI/CD to build and upload +then commit and push changes to the docker-openldap repository. It will trigger CI/CD to build and upload gcr.io/uit-authnz/openldap:latest image. ## Manual push to Google container registry