Add OSDK Helm docs #13231
Add OSDK Helm docs #13231
Conversation
openshift-ci-robot
added
do-not-merge/work-in-progress
openshift-ci-robot
added
size/XL
openshift-ci-robot
removed
the
do-not-merge/work-in-progress
| * Create a Nginx Service if it does not exist. | ||
| * Create a Nginx Ingress if it is enabled and does not exist. | ||
| * Ensure that the Deployment, Service, and optional Ingress match the desired | ||
| configuration (e.g., replica count, image, service type, etc.) as specified by |
| to provide customizations to a Helm chart's defaults, which are defined in the | ||
| Helm chart's `values.yaml` file. | ||
| + | ||
| Overriding these defaults is as simple as setting the desired values in the CR |
There was a problem hiding this comment.
Override these defaults by setting the desired values . . .
(It's good practice to avoid labelling processes as simple because if the user doesn't find the process simple, then they can feel silly or frustrated.)
| example-nginx-b9phnoz9spckcrua7ihrbkrt1-f8f9c875d-ljbzl 1/1 Running 0 1m | ||
| ---- | ||
| + | ||
| Check that the Service port is set to 8080: |
| example-nginx-b9phnoz9spckcrua7ihrbkrt1 3 3 3 3 1m | ||
| ---- | ||
| + | ||
| Check that the Service port is set to the default (80): |
ahardin-rh
added
the
peer-review-done
|
@adellape Just a few minor nits from me. 👍 |
|
@joelanford PTAL for tech review. |
modules/osdk-helm-chart-support.adoc
Outdated
| your application instance and have its desired state match what is running. In | ||
| the case of a Helm-based Operator, the object's spec field is a list of | ||
| configuration options that are typically described in Helm's `values.yaml` file. | ||
| Instead of setting these values with flags using the Helm CLI (e.g., `elm |
There was a problem hiding this comment.
| Instead of setting these values with flags using the Helm CLI (e.g., `elm | |
| Instead of setting these values with flags using the Helm CLI (e.g., `helm |
| $ operator-sdk up local | ||
| INFO[0000] Go Version: go1.10.3 | ||
| INFO[0000] Go OS/Arch: linux/amd64 | ||
| INFO[0000] operator-sdk Version: v0.1.1+git |
There was a problem hiding this comment.
I would suggest bumping the version number to v0.3.0+git. Same for the kubeconfig example below.
| .Prerequisites | ||
|
|
||
| - Operator SDK CLI installed on the development workstation | ||
| - Operator Lifecycle Manager (OLM) installed on a Kubernetes-based cluster (v1.8 |
There was a problem hiding this comment.
OLM is more of an addon than a prerequisite, right? I believe this is the only mention of OLM in this document.
There was a problem hiding this comment.
You're right, this is a leftover from reusing this list from elsewhere. Will remove.
| or above to support the `apps/v1beta2` API group), for example {product-title} | ||
| 4.0 | ||
| - Access to the cluster using an account with `cluster-admin` permissions | ||
| - link:https://kubernetes.io/docs/tasks/tools/install-kubectl/[`kubectl`] v1.11.0+ |
There was a problem hiding this comment.
Based on this comment and the bug it references, I think the minimum Kubernetes cluster version and kubectl version is 1.11.3.
|
Thx @ahardin-rh @joelanford, changes made. @jianzhangbjz Can you take a look for QE review? http://file.rdu.redhat.com/~adellape/010319/helm-sdk/operators/osdk-helm.html Thank you! Edit: Forgot we're gonna do QE later for 4.0 content. Merging as-is for now. |
|
@adellape I'm so sorry for the late to reply. I will review this document ASAP, thanks very much! |
|
/cherrypick master |
|
@adellape: new pull request created: #13350 In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
Looks great! Thanks! |
xref: https://jira.coreos.com/browse/OSDOCS-214
Preview: http://file.rdu.redhat.com/~adellape/010319/helm-sdk/operators/osdk-helm.html