Merge pull request #110 from gimlet-io/add-oci-support-for-onechart

Add OCI support for onechart

README.md

@@ -7,19 +7,34 @@ Because no-one can remember the Kubernetes yaml syntax.
 https://gimlet.io/docs/onechart-reference
 
 ## Getting started
+Check the generated Kubernetes yaml:
+```bash
+helm template my-release onechart/onechart \
+  --set image.repository=nginx \
+  --set image.tag=1.19.3
+```
+Deploy with Helm:
+
+```bash
+helm install my-release onechart/onechart \
+  --set image.repository=nginx \
+  --set image.tag=1.19.3
+```
+### Alternative: using an OCI repository
+You can also template and install onechart from an OCI repository as follows:
 
 Check the generated Kubernetes yaml:
 
 ```bash
-helm template my-release oci://ghcr.io/gimlet-io/onechart \
+helm template my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 \
   --set image.repository=nginx \
   --set image.tag=1.19.3
 ```
 
 Deploy with Helm:
 
 ```bash
-helm install my-release oci://ghcr.io/gimlet-io/onechart \
+helm install my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 \
   --set image.repository=nginx \
   --set image.tag=1.19.3
 ```

charts/cron-job/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0..0
+version: 0.62.0
 
 dependencies:
   - name: common

charts/onechart/Chart.yaml

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0..0
+version: 0.62.0
 
 dependencies:
   - name: common

charts/static-site/Chart.yaml

@@ -14,5 +14,5 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.64.0-rc.2
+version: 0.62.0
 

website/docs/examples/cron-job.md

@@ -23,7 +23,7 @@ command: |
   echo "hello"
 EOF
 
-helm template my-release onechart/cron-job -f values.yaml
+helm template my-release oci://ghcr.io/gimlet-io/cron-job --version 0.62.0
 ```
 
 !!! warning

website/docs/examples/custom-command.md

@@ -21,7 +21,7 @@ command: |
   while true; do date; sleep 2; done
 EOF
 
-helm template my-release oci://ghcr.io/gimlet-io/onechart -f values.yaml
+helm template my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 -f values.yaml
 ```
 
 ### Using bash

website/docs/examples/debugSidecar.md

@@ -17,5 +17,5 @@ volumes:
 Check the Kubernetes manifest:
 
 ```bash
-helm template my-release oci://ghcr.io/gimlet-io/onechart -f values.yaml
+helm template my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 -f values.yaml
 ```

website/docs/examples/deploying-a-private-image.md

@@ -21,7 +21,7 @@ imagePullSecrets:
  - name: regcred
 EOF
 
-helm template my-release oci://ghcr.io/gimlet-io/onechart -f values.yaml
+helm template my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 -f values.yaml
 ```
 
 !!! warning

website/docs/examples/deploying-an-image.md

@@ -15,5 +15,5 @@ image:
   tag: 1.19.3
 EOF
 
-helm template my-release oci://ghcr.io/gimlet-io/onechart -f values.yaml
+helm template my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 -f values.yaml
 ```

website/docs/examples/domain-names.md

@@ -25,7 +25,7 @@ ingress:
   host: my-release.mycompany.com
 EOF
 
-helm template my-release oci://ghcr.io/gimlet-io/onechart -f values.yaml
+helm template my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 -f values.yaml
 ```
 
 !!! warning
@@ -48,5 +48,5 @@ ingress:
   tlsEnabled: true
 EOF
 
-helm template my-release oci://ghcr.io/gimlet-io/onechart -f values.yaml
+helm template my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 -f values.yaml
 ```

website/docs/examples/environment-variables.md

@@ -21,7 +21,7 @@ image:
 
 EOF
 
-helm template my-release oci://ghcr.io/gimlet-io/onechart -f values.yaml
+helm template my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 -f values.yaml
 ```
 
 !!! note

website/docs/examples/feature-branch-deploys.md

@@ -12,7 +12,7 @@ Release name is unique in Helm too, so it makes it a good tool to drive resource
 One good practice can be to add a `-$BRANCH` suffix to the feature branch instance:
 
 ```
-helm template my-release-my-branch oci://ghcr.io/gimlet-io/onechart -f values.yaml
+helm template my-release-my-branch oci://ghcr.io/gimlet-io/onechart --version 0.62.0 -f values.yaml
 ```
 
 ### Avoiding domain name collision

website/docs/examples/prometheus-monitoring-rules.md

@@ -23,5 +23,5 @@ prometheusRules:
 Check the Kubernetes manifest:
 
 ```bash
-helm template my-release oci://ghcr.io/gimlet-io/onechart -f values.yaml
+helm template my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 -f values.yaml
 ```

website/docs/examples/secrets.md

@@ -25,7 +25,7 @@ secret:
   enabled: true
 EOF
 
-helm template my-release oci://ghcr.io/gimlet-io/onechart -f values.yaml
+helm template my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 -f values.yaml
 ```
 
 ### Using encrypted secret values

website/docs/examples/volumes.md

@@ -27,7 +27,7 @@ volumes:
     storageClass: default
 EOF
 
-helm template my-release oci://ghcr.io/gimlet-io/onechart -f values.yaml
+helm template my-release oci://ghcr.io/gimlet-io/onechart --version 0.62.0 -f values.yaml
 ```
 
 !!! warning