Created getting started wtih gitops procedure module #29411

jc-berger · 2021-02-10T22:13:03Z

Adds an overview for GitOps and addresses Jira Issue, Adding documentation for configuring Curator #2475.
Targeted to OCP 4.7
Aligned team label: Dev Tools
Acknowledged by QE. See Shoubhik's "looks good to me" comment.
For easy reference, here's a preview of the rendered version.

netlify · 2021-02-10T22:14:17Z

Deploy preview for osdocs ready!

Built with commit 9908ec9

https://deploy-preview-29411--osdocs.netlify.app

modules/getting-started-openshift-gitops.adoc

cicd/gitops/getting-started-with-openshift-gitops.adoc

jc-berger · 2021-02-18T02:20:40Z

@Preeticp, new commit is up, addressing your feedback! I'll look into the build failure tomorrow...I suspect it's because of a doc I've deleted (outdated module). Thanks for the help. Now I'll await the dev SME review!

_topic_map.yml

cicd/gitops/getting-started-with-openshift-gitops.adoc

modules/getting-started-with-cluster-configurations.adoc

modules/setting-up-an-openshift-login.adoc

modules/setting-up-a-new-argocd-instance.adoc

jc-berger · 2021-02-18T21:57:34Z

@Preeticp and @sbose78, thank you both for the awesome review :)

The big issue I have is that I see this branch has conflicts and I am unable to rebase my branch because of the conflicting _topic_map.yml. Either of you know what could be causing this issue?

cicd/gitops/getting-started-with-openshift-gitops.adoc

modules/launching-the-operator-provided-argocd-instance.adoc

modules/setting-up-a-customized-argocd-instance.adoc

modules/setting-up-an-openshift-login.adoc

modules/setting-up-a-customized-argocd-instance.adoc

sbose78 · 2021-02-19T15:25:13Z

Looks good to me!

kalexand-rh

This looks like two different user stories wedged into the same assembly, you have some malformed modules, and I am confused about part of the flow.

cicd/gitops/getting-started-with-openshift-gitops.adoc

modules/launching-the-operator-provided-argocd-instance.adoc

kalexand-rh · 2021-02-19T19:57:54Z

modules/setting-up-an-openshift-login.adoc

Suggested change

After you create a new client in Keycloak and generate an *argocd-secret* in the Argo CD secret, you get a client secret. To configure Argo CD OIDC, store this client secret with the following instructions:

. Configure Argo CD OpenID Connect (OIDC) to connect to your Keycloak instance:

kalexand-rh · 2021-02-19T19:58:32Z

modules/setting-up-an-openshift-login.adoc

Suggested change

. Encode the client secret in base64:

.. Encode the client secret in base64:

kalexand-rh · 2021-02-19T20:00:02Z

modules/setting-up-an-openshift-login.adoc

Suggested change

$ echo -n '83083958-8ec6-47b0-a411-a8c55381fbd2' | base64

$ echo -n '<argocd-secret>' | base64 <1>

Then after the codeblock, add something like:

<1> Enter the `<argocd-secret>` value that you obtained from your Keycloak server.

kalexand-rh · 2021-02-19T20:04:56Z

modules/setting-up-an-openshift-login.adoc

From this point on, you've completely lost me. The descriptions of the steps don't appear to correspond to the commands that you're using, and I am extremely confused what of the YAML you're showing as example is actually there and what the user needs to customize. The YAML format itself looks slightly off - I've never seen a YAML example start with a "$." Please review the rest of the module and try to be clearer. Use the annotation format from some of the other YAML examples to explain what's going on.

kalexand-rh · 2021-02-19T20:06:15Z

modules/setting-up-an-openshift-login.adoc

I would not make this a separate step. I'd make these checks annotations on the YAML itself. This format is hard to follow.

Preeticp · 2021-02-22T18:13:43Z

Hi @kalexand-rh thanks a ton for your thorough review, appreciate it.
Post discussions with the dev team, we thought it best to add in a brief getting started for the TP release, and then add in the other changes incrementally.
We have removed the: modules/setting-up-an-openshift-login.adoc and the modules/setting-up-a-customized-argocd-instance.adoc from this PR, and have created Jiras to fix them post GA: https://issues.redhat.com/browse/RHDEVDOCS-2695 and https://issues.redhat.com/browse/RHDEVDOCS-2696. The Jiras have links to the relevant comment for both modules so that we have a record and fix all the comments.

dewan-ahmed · 2021-02-22T18:29:56Z

Hi, few comments:

On step 3d. Select the argo-cluster-cluster instance to display the password., I think the name of the password is argocd-cluster-cluster
From what I read, the getting started doc is guiding the customer up to the running ArgoCD instance. Was that the entire scope of the getting started doc? My take on this is providing more information to a customer i.e. how to make use of that instance in terms of creating a sample argocd application. Since this is a new product and not so much content exist on this online, these docs would be the only go-to places so my preference is to provide a bit more info. @sbose78 @wtam2018 can comment further.

sbose78 · 2021-02-22T18:34:39Z

Getting started definitely needs to involve

Installing OpenShift GitOps/ArgoCD as an "admin".
Enabling users/admins to deploy applications with it.

We don't need all of it to go in together though :)

corrected metadata, module structure, and minor content changes revised content, made modules and assembly corrected typo to remove build error changed xref to resolve build error added module to include openshift login content and structure changes to modules and assembly fixed xref to resolve build error fixed xref to resolve build error# more content and heading changes modular and structural changes changed introduction to module minor grmmatical changes corrected UI elements

sbose78

👍

kalexand-rh

I think that this looks good and has a much better scope for a "Getting started" topic!

codyhoag · 2021-02-22T19:23:49Z

/cherrypick enterprise-4.7

openshift-cherrypick-robot · 2021-02-22T19:24:30Z

@codyhoag: new pull request created: #29661

In response to this:

/cherrypick enterprise-4.7

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.

openshift-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 10, 2021

jc-berger force-pushed the jcberger_2475_gettingstartedgitops branch from 2483030 to 3bea5c8 Compare February 15, 2021 21:29

jc-berger requested review from aburdenthehand, codyhoag, jeana-redhat and vikram-redhat as code owners February 15, 2021 21:29

Preeticp reviewed Feb 16, 2021

View reviewed changes

modules/getting-started-openshift-gitops.adoc Outdated Show resolved Hide resolved

Preeticp reviewed Feb 16, 2021

View reviewed changes

modules/getting-started-openshift-gitops.adoc Outdated Show resolved Hide resolved

Preeticp reviewed Feb 16, 2021

View reviewed changes

modules/getting-started-openshift-gitops.adoc Outdated Show resolved Hide resolved

Preeticp reviewed Feb 16, 2021

View reviewed changes

modules/getting-started-openshift-gitops.adoc Outdated Show resolved Hide resolved

Preeticp reviewed Feb 16, 2021

View reviewed changes

modules/getting-started-openshift-gitops.adoc Outdated Show resolved Hide resolved

Preeticp reviewed Feb 16, 2021

View reviewed changes

jc-berger force-pushed the jcberger_2475_gettingstartedgitops branch from 3bea5c8 to cca95ee Compare February 18, 2021 02:00

jc-berger commented Feb 18, 2021

View reviewed changes

cicd/gitops/getting-started-with-openshift-gitops.adoc Outdated Show resolved Hide resolved

jc-berger commented Feb 18, 2021

View reviewed changes

_topic_map.yml Outdated Show resolved Hide resolved

jc-berger force-pushed the jcberger_2475_gettingstartedgitops branch 3 times, most recently from 1e9754f to 745d535 Compare February 18, 2021 18:15

openshift-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 18, 2021

Preeticp reviewed Feb 18, 2021

View reviewed changes

sbose78 reviewed Feb 18, 2021

View reviewed changes

modules/setting-up-an-openshift-login.adoc Outdated Show resolved Hide resolved

modules/setting-up-an-openshift-login.adoc Outdated Show resolved Hide resolved

modules/setting-up-a-new-argocd-instance.adoc Outdated Show resolved Hide resolved

jc-berger force-pushed the jcberger_2475_gettingstartedgitops branch from 745d535 to a5204c9 Compare February 18, 2021 21:53

openshift-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 18, 2021

jc-berger force-pushed the jcberger_2475_gettingstartedgitops branch 2 times, most recently from 0496300 to e54c02f Compare February 19, 2021 13:14

Preeticp reviewed Feb 19, 2021

View reviewed changes

jc-berger force-pushed the jcberger_2475_gettingstartedgitops branch from e54c02f to 8a77b12 Compare February 19, 2021 15:08

jc-berger changed the title ~~WIP: created getting started wtih gitops procedure module~~ Created getting started wtih gitops procedure module Feb 19, 2021

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Feb 19, 2021

kalexand-rh reviewed Feb 19, 2021

View reviewed changes

kalexand-rh added peer-review-done Signifies that the peer review team has reviewed this PR branch/enterprise-4.7 labels Feb 19, 2021

kalexand-rh added this to the Future Release milestone Feb 19, 2021

vikram-redhat added the dev-tools Label for all Odo/Pipelines/Helm/Developer Console/Perspective PRs label Feb 20, 2021

jc-berger force-pushed the jcberger_2475_gettingstartedgitops branch from 8a77b12 to d2a09ef Compare February 22, 2021 17:08

openshift-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 22, 2021

jc-berger force-pushed the jcberger_2475_gettingstartedgitops branch from d2a09ef to a90062a Compare February 22, 2021 17:36

jc-berger force-pushed the jcberger_2475_gettingstartedgitops branch from a90062a to 07ec9f6 Compare February 22, 2021 18:44

jc-berger force-pushed the jcberger_2475_gettingstartedgitops branch from 07ec9f6 to 9908ec9 Compare February 22, 2021 18:45

sbose78 approved these changes Feb 22, 2021

View reviewed changes

kalexand-rh reviewed Feb 22, 2021

View reviewed changes

codyhoag approved these changes Feb 22, 2021

View reviewed changes

codyhoag merged commit d5ffdb2 into openshift:master Feb 22, 2021

openshift-cherrypick-robot mentioned this pull request Feb 22, 2021

[enterprise-4.7] Created getting started wtih gitops procedure module #29661

Merged

vikram-redhat modified the milestones: Future Release, OCP 4.7 GA Feb 24, 2021

	After you create a new client in Keycloak and generate an argocd-secret in the Argo CD secret, you get a client secret. To configure Argo CD OIDC, store this client secret with the following instructions:
	. Configure Argo CD OpenID Connect (OIDC) to connect to your Keycloak instance:

	. Encode the client secret in base64:
	.. Encode the client secret in base64:

	$ echo -n '83083958-8ec6-47b0-a411-a8c55381fbd2' \| base64
	$ echo -n '<argocd-secret>' \| base64 <1>

Created getting started wtih gitops procedure module #29411

Created getting started wtih gitops procedure module #29411

Uh oh!

Conversation

jc-berger commented Feb 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify bot commented Feb 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jc-berger commented Feb 18, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jc-berger commented Feb 18, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sbose78 commented Feb 19, 2021

Uh oh!

kalexand-rh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kalexand-rh Feb 19, 2021

Choose a reason for hiding this comment

Uh oh!

kalexand-rh Feb 19, 2021

Choose a reason for hiding this comment

Uh oh!

kalexand-rh Feb 19, 2021

Choose a reason for hiding this comment

Uh oh!

kalexand-rh Feb 19, 2021

Choose a reason for hiding this comment

Uh oh!

kalexand-rh Feb 19, 2021

Choose a reason for hiding this comment

Uh oh!

Preeticp commented Feb 22, 2021

Uh oh!

jc-berger commented Feb 10, 2021 •

edited

Loading

netlify bot commented Feb 10, 2021 •

edited

Loading