consolidating and expanding examples

Author: robscott

README.md

@@ -16,6 +16,19 @@ We currently include a variety of CI Images, including Alpine and Debian Stretch
 
 The latest Debian Stretch release can be pulled from `quay.io/reactiveops/ci-images:v7-stretch`. A full list of the latest image tags is available on our [Quay repository](https://quay.io/repository/reactiveops/ci-images).
 
+## Examples
+
+rok8s-scripts is designed to work well in a wide variety of environments. That includes Bitbucket Pipelines, CircleCI, GitLab CI, and more. There are many valid ways to configure CI pipelines, we've includes a variety of [examples](/examples) in this repository.
+
+Most notably, the CI example includes sample configuration for the following platforms:
+
+- [Bitbucket Pipelines](/examples/ci/bitbucket-pipelines.yml)
+- [CircleCI](/examples/ci/.circleci/config.yml)
+- [GitLab CI](/examples/ci/.gitlab-ci.yml)
+- [Jenkins](/examples/ci/Jenkinsfile)
+
+On their own, these examples may not make a lot of sense. There's a lot more documentation below that should cover everything included in these examples and more.
+
 ## Further Reading
 
 - [Building and Pushing Docker Images](/docs/docker.md)

docs/index.md

@@ -16,7 +16,21 @@ We currently include a variety of CI Images, including Alpine and Debian Stretch
 
 The latest Debian Stretch release can be pulled from `quay.io/reactiveops/ci-images:v7-stretch`. A full list of the latest image tags is available on our [Quay repository](https://quay.io/repository/reactiveops/ci-images).
 
+## Examples
+
+rok8s-scripts is designed to work well in a wide variety of environments. That includes Bitbucket Pipelines, CircleCI, GitLab CI, and more. There are many valid ways to configure CI pipelines, we've includes a variety of [examples](/examples) in this repository.
+
+Most notably, the CI example includes sample configuration for the following platforms:
+
+- [Bitbucket Pipelines](/examples/ci/bitbucket-pipelines.yml)
+- [CircleCI](/examples/ci/.circleci/config.yml)
+- [GitLab CI](/examples/ci/.gitlab-ci.yml)
+- [Jenkins](/examples/ci/Jenkinsfile)
+
+On their own, these examples may not make a lot of sense. There's a lot more documentation below that should cover everything included in these examples and more.
+
 ## Further Reading
+
 - [Building and Pushing Docker Images](/docs/docker.md)
 - [Deploying to Kubernetes with Helm](/docs/helm.md)
 - [Deploying to Kubernetes without Helm](/docs/without_helm.md)
@@ -26,11 +40,6 @@ The latest Debian Stretch release can be pulled from `quay.io/reactiveops/ci-ima
 - [Amazon Web Services](/docs/aws.md)
 - [Google Cloud](/docs/gcp.md)
 
-### CI Specific Documentation
-- CircleCI
-- GitLab CI
-- Bitbucket Pipelines
-
 ### Contributing
 - [Releasing New Versions of rok8s-scripts](/docs/releasing.md)
 

docs/without_helm.md

@@ -46,6 +46,10 @@ k8s-deploy-and-verify -f deploy/development.config
 
 More indepth examples are available in the [examples directory](/examples).
 
+## Versioning
+**If a Docker image is used in the file then any cases of `:latest` will be replaced with th `CI_SHA1` if it is defined.** This allows a set image tag to be used when deploying from a CI system. When files that could use `CI_SHA1` are deployed, a new file will be created with that value as part of the filename.
+
+If using an HPA, set `replicas: hpa` in the deployment file to have k8s-deploy get the current number of replicas from the cluster and deploy that number of replicas. This is a workaround for an open issue (https://github.com/kubernetes/kubernetes/issues/25238).
 
 ## Deployment Configuration
 Listed below are all the types of resources rok8s-scripts supports. In all cases, the filename suffix is important and must match the spec precisely.