Skip to content

Commit

Permalink
Tweak docs. Fix gitignore. Update references to 11.7 (#385)
Browse files Browse the repository at this point in the history
* prep for 11.7 release

* Tweak docs. Fix gitignore. Update references to 11.7
  • Loading branch information
Andrew Suderman authored Mar 29, 2021
1 parent 7d952d9 commit a673c23
Show file tree
Hide file tree
Showing 12 changed files with 17 additions and 17 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,3 @@ test/lib/
test/pip-selfcheck.json
node_modules
/dist
*.swp
2 changes: 1 addition & 1 deletion docs/ci-images.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Each new release of rok8s-scripts generates CI images for common workflows. These images include a set of common CI/CD dependencies, including Docker, Kubernetes, Helm, AWS, and Google Cloud client libraries. Starting with these images as a base for deployment workflows ensures that you don't need to spend any build time installing extra dependencies.

We currently include CI Images based on Alpine and Debian Stretch as our recommended starting points. The latest Debian Stretch release can be pulled from `quay.io/reactiveops/ci-images:v11.6-stretch`. A full list of image tags is available on our [Quay repository](https://quay.io/repository/reactiveops/ci-images).
We currently include CI Images based on Alpine and Debian Stretch as our recommended starting points. The latest Debian Stretch release can be pulled from `quay.io/reactiveops/ci-images:v11.7-stretch`. A full list of image tags is available on our [Quay repository](https://quay.io/repository/reactiveops/ci-images).

**Deprecation Notice** As of v10 and onward, alpine and stretch will be the only available images.

Expand Down
7 changes: 4 additions & 3 deletions docs/helm.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,11 +56,12 @@ somevalue: anothervalue
```
### Values Set Automatically
The helm-deploy and helm-template scripts set 3 Helm values automatically.
1. `$HELM_IMAGE_TAG_VALUE_REF` default of `image.tag` is set to the value of `$CI_SHA1`, a value that should represent the Git commit sha for the current build.
2. `$HELM_ROK8S_CI_REF_VALUE_REF` default of `rok8sCIRef` refers to the value of `$CI_TAG` if it is set, otherwise defaults to the value of `$CI_BRANCH`.
3. `$HELM_ROK8S_SANITIZED_BRANCH_VALUE_REF` default of `sanitizedBranch` refers to the value of `$SANITIZED_BRANCH`, a URL safe value we derive from the value of `$CI_BRANCH`. This value can be quite useful for deploying ephemeral environments.
1. `$HELM_IMAGE_TAG_VALUE_REF` (default `image.tag`) is set to the value of `$CI_SHA1`, a value that represents the Git commit sha for the current build.
2. `$HELM_ROK8S_CI_REF_VALUE_REF` (default `rok8sCIRef`) is set to the value of `$CI_TAG` if it is set, otherwise defaults to the value of `$CI_BRANCH`.
3. `$HELM_ROK8S_SANITIZED_BRANCH_VALUE_REF` (default `sanitizedBranch`) is set to the value of `$SANITIZED_BRANCH`, a URL-safe value that is derived from the value of `$CI_BRANCH`. This value can be quite useful for deploying ephemeral environments.

## Secret Management
Helm stores release information in Config Maps. If we deployed Kubernetes Secrets with Helm, they'd also be visible in that Helm release Config Map. To avoid that, we manage secrets separately. Please see [Managing Kubernetes Secrets Securely](secrets.md) for further information.
Expand Down
2 changes: 1 addition & 1 deletion docs/versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Here is a set of guidelines to follow when deciding what version of ci-images (a

You want rok8s-scripts to be stable, and just keep working until you decide to upgrade.

In this scenario, you should pin to a minor version of rok8s-scripts such as `v11.6-alpine`.
In this scenario, you should pin to a minor version of rok8s-scripts such as `v11.7-alpine`.

#### You like to live dangerously

Expand Down
4 changes: 2 additions & 2 deletions examples/ci/.circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ references:
deploy_steps: &deploy_steps
docker:
- image: quay.io/reactiveops/ci-images:v11.6-alpine
- image: quay.io/reactiveops/ci-images:v11.7-alpine
steps:
- checkout
- *set_environment_variables
Expand All @@ -24,7 +24,7 @@ references:
jobs:
imagebuild:
docker:
- image: quay.io/reactiveops/ci-images:v11.6-alpine
- image: quay.io/reactiveops/ci-images:v11.7-alpine
steps:
- checkout
- setup_remote_docker
Expand Down
2 changes: 1 addition & 1 deletion examples/ci/.gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ variables:
DOCKER_HOST: tcp://localhost:2375
DOCKER_DRIVER: overlay2

image: quay.io/reactiveops/ci-images:v11.6-alpine
image: quay.io/reactiveops/ci-images:v11.7-alpine
services:
- docker:dind

Expand Down
2 changes: 1 addition & 1 deletion examples/ci/bitbucket-pipelines.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
image: quay.io/reactiveops/ci-images:v11.6-stretch
image: quay.io/reactiveops/ci-images:v11.7-stretch

aliases:
- &initialize-env |
Expand Down
2 changes: 1 addition & 1 deletion examples/external-secrets-manager/.circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ references:
jobs:
deploy:
docker:
- image: quay.io/reactiveops/ci-images:v11.6-stretch
- image: quay.io/reactiveops/ci-images:v11.7-stretch
steps:
- checkout
- setup_remote_docker
Expand Down
4 changes: 2 additions & 2 deletions examples/minimal-sops-secrets/.circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ references:
jobs:
build_image:
docker:
- image: quay.io/reactiveops/ci-images:v11.6-stretch
- image: quay.io/reactiveops/ci-images:v11.7-stretch
steps:
- checkout
- setup_remote_docker
- *set_environment_variables
- *build_image
deploy:
docker:
- image: quay.io/reactiveops/ci-images:v11.6-stretch
- image: quay.io/reactiveops/ci-images:v11.7-stretch
steps:
- checkout
- setup_remote_docker
Expand Down
2 changes: 1 addition & 1 deletion examples/minimal-sops-secrets/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ we run some of the scripts provided by rok8s-scripts. In particular, we use:
* `k8s-deploy-and-verify` to deploy our image to Kubernetes and make sure the deployment succeeded
* This also calls the `k8s-deploy-secrets` script to decrypt and deploy secrets

We also use the rok8s-scripts CI image, `quay.io/reactiveops/ci-images:v11.6-stretch`,
We also use the rok8s-scripts CI image, `quay.io/reactiveops/ci-images:v11.7-stretch`,
to ensure rok8s-scripts and its dependencies are available during the build and deploy jobs.

## Try it out
Expand Down
4 changes: 2 additions & 2 deletions examples/minimal/.circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ references:
jobs:
build_image:
docker:
- image: quay.io/reactiveops/ci-images:v11.6-stretch
- image: quay.io/reactiveops/ci-images:v11.7-stretch
steps:
- checkout
- setup_remote_docker
- *set_environment_variables
- *build_image
deploy:
docker:
- image: quay.io/reactiveops/ci-images:v11.6-stretch
- image: quay.io/reactiveops/ci-images:v11.7-stretch
steps:
- checkout
- setup_remote_docker
Expand Down
2 changes: 1 addition & 1 deletion examples/minimal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ we run some of the scripts provided by rok8s-scripts. In particular, we use:
* `prepare-kubectl` to configure the `kubectl` command to be able to deploy resources to our Kubernetes cluster
* `k8s-deploy-and-verify` to deploy our image to Kubernetes and make sure the deployment succeeded

We also use the rok8s-scripts CI image, `quay.io/reactiveops/ci-images:v11.6-stretch`,
We also use the rok8s-scripts CI image, `quay.io/reactiveops/ci-images:v11.7-stretch`,
to ensure rok8s-scripts and its dependencies are available during the build and deploy jobs.

## Try it out
Expand Down

0 comments on commit a673c23

Please sign in to comment.