doc: quickstart for Helm projects and more details for the migration guide by camilamacedo86 · Pull Request #3552 · operator-framework/operator-sdk

camilamacedo86 · 2020-07-26T22:20:33Z

Description of the change:

The quickstart was moved to tutorial
Update the links and the order to show the docs (See: https://deploy-preview-3552--operator-sdk.netlify.app/docs/building-operators/helm/quickstart/)
Update the migration guide with more details (See: https://deploy-preview-3552--operator-sdk.netlify.app/docs/building-operators/helm/migration/)

Motivation for the change:

bharathi-tenneti

Some nits.

bharathi-tenneti · 2020-07-28T15:40:24Z

+  chart: helm-charts/nginx
+# +kubebuilder:scaffold:watch
+```
+


Bottom note about adding additional APIs, might be placed here, to be relevant.

Suggested change

**NOTE** Additional CR/CRD's can be added to the project by running, for example, the command :`operator-sdk create api --group=example --version=v1alpha1 --kind=AppService`

I did not add it at the latest version. After check all again, I saw that it is at the end of the file already.

joelanford · 2020-07-28T17:33:05Z

@camilamacedo86 Given how simple this quickstart will be, I'm thinking we should eliminate all of the headers and basically just list the commands one after the other, maybe with single sentence descriptions of what each command does.

I think we want this to be simple for people to copy and paste from, so combining several commands in a
console code block might be helpful. Like this

Initialize a project, create your first API, and build and push the operator image:
```console
mkdir demo-operator && cd demo-operator
operator-sdk init --plugins=helm
operator-sdk create api ...
make docker-build docker-push IMG=<repo>/<name>:<tag>
```

Install the CRDs and run the operator:
```console
make install
make deploy IMG=<repo>/<name>:<tag>
```

Create a sample custom resource and wait for the operator to create an nginx deployment:
```console
kubectl apply -f ./config/samples/...
kubectl get deployment -w | grep nginx-sample
```

Uninstall the operator
```console
make undeploy
```

joelanford · 2020-07-29T12:51:27Z

+**Note** Ensure that you use the same values for the flags to recreate the same Helm chart and API. If you have
+more than one chart or API you can add them via `operator-sdk create api` command. For further information check the [Helm Quickstart][quickstart]. 


I think this change makes the doc less clear. I think we should revert this, and add an extra sentence about --version and --kind

Suggested change

**Note** Ensure that you use the same values for the flags to recreate the same Helm chart and API. If you have

more than one chart or API you can add them via `operator-sdk create api` command. For further information check the [Helm Quickstart][quickstart].

Now that we have our new project initialized, we need to re-create each of our APIs.

Using our API example from earlier (`cache.example.com`), we'll use `cache` for the

`--group` flag.

For `--version` and `--kind`, we use `spec.versions[0].name` and `spec.names.kind`, respectively.

joelanford · 2020-07-29T12:51:59Z

+more than one chart or API you can add them via `operator-sdk create api` command. For further information check the [Helm Quickstart][quickstart]. 

 For each API in the existing project, run:
 ```sh


This example create api codeblock needs to be updated. There is no longer an --api-version flag.

joelanford · 2020-07-29T12:56:23Z

+In case your project has customizations in the `deploy/operator.yaml` then, it needs to be port to 
+`config/manager/manager.yaml`. However, note that the following env vars are no longer used. 


Suggested change

In case your project has customizations in the `deploy/operator.yaml` then, it needs to be port to

`config/manager/manager.yaml`. However, note that the following env vars are no longer used.

If your existing project has customizations in `deploy/operator.yaml`, they need to be ported to

`config/manager/manager.yaml`. If you are passing custom arguments in your deployment, make sure to also update `config/default/auth_proxy_patch.yaml`.

Note that the following environment variables are no longer used.

joelanford · 2020-07-29T12:59:21Z


-This guide walks through an example of building a simple nginx-operator powered by [Helm][helm-official] using tools and libraries provided by the Operator SDK.
+This guide walks through an example of building a simple nginx operator
+powered by Helm using tools and libraries provided by the Operator SDK.


We should add the official Helm link back. I may have accidentally dropped that in the commit that I pushed.

joelanford

/lgtm

After final comments are addressed.

openshift-ci-robot · 2020-07-29T13:23:18Z

New changes are detected. LGTM label has been removed.

openshift-ci-robot requested review from estroz and shawn-hurley July 26, 2020 22:20

camilamacedo86 changed the title ~~doc: add helm quickstart~~ doc: quickstart for Helm projects Jul 26, 2020

camilamacedo86 requested review from asmacdo, fabianvf, jmccormick2001, jmrodri and joelanford July 26, 2020 22:21

joelanford mentioned this pull request Jul 26, 2020

Operator SDK 1.0 Meta-issue #3327

Closed

92 tasks

camilamacedo86 removed request for estroz and shawn-hurley July 26, 2020 23:01

camilamacedo86 added this to the v1.0.0 milestone Jul 27, 2020

camilamacedo86 added kind/documentation Categorizes issue or PR as related to documentation. language/helm Issue is related to a Helm operator project labels Jul 27, 2020

camilamacedo86 changed the title ~~doc: quickstart for Helm projects~~ doc: quickstart for Helm projects and more details for the migration guide Jul 28, 2020

bharathi-tenneti reviewed Jul 28, 2020

View reviewed changes

Comment thread website/content/en/docs/building-operators/helm/quickstart.md Outdated

bharathi-tenneti reviewed Jul 28, 2020

View reviewed changes

joelanford requested changes Jul 28, 2020

View reviewed changes

openshift-ci-robot added needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. and removed needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. labels Jul 28, 2020

joelanford self-requested a review July 28, 2020 20:30

joelanford reviewed Jul 28, 2020

View reviewed changes

Comment thread website/content/en/docs/building-operators/helm/migration.md Outdated

joelanford reviewed Jul 29, 2020

View reviewed changes

joelanford approved these changes Jul 29, 2020

View reviewed changes

openshift-ci-robot assigned joelanford Jul 29, 2020

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Jul 29, 2020

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Jul 29, 2020

camilamacedo86 added 4 commits July 29, 2020 16:06

doc: add helm quickstart and improve miggration guide

34ebd89

rebase fix

23af7d5

rebase fix

fca038b

remove

6f7252b

camilamacedo86 merged commit f2088cf into operator-framework:master Jul 29, 2020

camilamacedo86 deleted the helm-doc-quick branch July 29, 2020 15:38


	NOTE Additional CR/CRD's can be added to the project by running, for example, the command :`operator-sdk create api --group=example --version=v1alpha1 --kind=AppService`

		Note Ensure that you use the same values for the flags to recreate the same Helm chart and API. If you have
		more than one chart or API you can add them via `operator-sdk create api` command. For further information check the [Helm Quickstart][quickstart].

-**Note** Ensure that you use the same values for the flags to recreate the same Helm chart and API. If you have
-more than one chart or API you can add them via `operator-sdk create api` command. For further information check the [Helm Quickstart][quickstart].
+Now that we have our new project initialized, we need to re-create each of our APIs.
+Using our API example from earlier (`cache.example.com`), we'll use `cache` for the
+`--group` flag.
+For `--version` and `--kind`, we use `spec.versions[0].name` and `spec.names.kind`, respectively.

		In case your project has customizations in the `deploy/operator.yaml` then, it needs to be port to
		`config/manager/manager.yaml`. However, note that the following env vars are no longer used.

-In case your project has customizations in the `deploy/operator.yaml` then, it needs to be port to
-`config/manager/manager.yaml`. However, note that the following env vars are no longer used.
+If your existing project has customizations in `deploy/operator.yaml`, they need to be ported to
+`config/manager/manager.yaml`. If you are passing custom arguments in your deployment, make sure to also update `config/default/auth_proxy_patch.yaml`.
+Note that the following environment variables are no longer used.

Conversation

camilamacedo86 commented Jul 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

bharathi-tenneti left a comment

Choose a reason for hiding this comment

Uh oh!

bharathi-tenneti Jul 28, 2020

Choose a reason for hiding this comment

Uh oh!

camilamacedo86 Jul 29, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

joelanford commented Jul 28, 2020

Uh oh!

Uh oh!

joelanford Jul 29, 2020

Choose a reason for hiding this comment

Uh oh!

joelanford Jul 29, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

joelanford Jul 29, 2020

Choose a reason for hiding this comment

Uh oh!

joelanford Jul 29, 2020

Choose a reason for hiding this comment

Uh oh!

joelanford left a comment

Choose a reason for hiding this comment

Uh oh!

openshift-ci-robot commented Jul 29, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

camilamacedo86 commented Jul 26, 2020 •

edited

Loading

joelanford Jul 29, 2020 •

edited

Loading