Skip to content

Conversation

@nickboldt
Copy link
Member

@nickboldt nickboldt commented Nov 12, 2024

What does this PR do?

chore(installation): remove doc about non-OLM installation method; add extra link to OLM quickstart at https://olm.operatorframework.io/docs/getting-started/ (RHIDP-2707) (RHIDP-3497)

Signed-off-by: Nick Boldt [email protected]

Screenshot/screencast of this PR

N/A

What issues does this PR fix or reference?

How to test this PR?

N/A

PR Checklist

As the author of this Pull Request I made sure that:

  • Code produced is complete
  • Code builds without errors
  • Tests are covering the bugfix
  • Relevant user documentation updated
  • Relevant contributing documentation updated

Reviewers

Reviewers, please comment how you tested the PR when approving it.

@nickboldt nickboldt changed the title chore(installation): remove doc about... chore(installation): remove doc about non-OLM instlalation method; add extra link to OLM quickstart at https://olm.operatorframework.io/docs/getting-started/ (RHIDP-2707) (RHIDP-3497) Nov 12, 2024
@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Nov 12, 2024

@nickboldt nickboldt changed the title chore(installation): remove doc about non-OLM instlalation method; add extra link to OLM quickstart at https://olm.operatorframework.io/docs/getting-started/ (RHIDP-2707) (RHIDP-3497) chore(installation): remove non-OLM installation doc; add link to OLM quickstart (RHIDP-2707) (RHIDP-3497) Nov 12, 2024
@nickboldt
Copy link
Member Author

/cherry-pick release-1.3
/cherry-pick 1.2.x

@openshift-cherrypick-robot
Copy link
Contributor

@nickboldt: once the present PR merges, I will cherry-pick it on top of 1.2.x, release-1.3 in new PRs and assign them to you.

In response to this:

/cherry-pick release-1.3
/cherry-pick 1.2.x

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-sigs/prow repository.

Copy link
Member

@rm3l rm3l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should also update the instructions for AKS: https://docs.redhat.com/en/documentation/red_hat_developer_hub/1.3/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-operator_title-install-rhdh-aks#proc-rhdh-deploy-aks-operator_title-install-rhdh-aks

Right now, the first step in this procedure is Obtain the Red Hat Developer Hub Operator manifest file, named rhdh-operator-<VERSION>.yaml [...] (with no information on how to obtain that manifest), then Apply the modified Operator manifest to your Kubernetes cluster. There is no mention of OLM there.

But the instructions to install the Operator with OLM should be quite similar on AKS and EKS (not sure if the last step on changing the Service Type to NodePort is needed on AKS).

cc @gazarenkov

@rm3l
Copy link
Member

rm3l commented Nov 13, 2024

/hold

Copy link
Member

@rm3l rm3l left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should also update the instructions for AKS: docs.redhat.com/en/documentation/red_hat_developer_hub/1.3/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-operator_title-install-rhdh-aks#proc-rhdh-deploy-aks-operator_title-install-rhdh-aks

Right now, the first step in this procedure is Obtain the Red Hat Developer Hub Operator manifest file, named rhdh-operator-<VERSION>.yaml [...] (with no information on how to obtain that manifest), then Apply the modified Operator manifest to your Kubernetes cluster. There is no mention of OLM there.

But the instructions to install the Operator with OLM should be quite similar on AKS and EKS (not sure if the last step on changing the Service Type to NodePort is needed on AKS).

As discussed, this can be updated in a follow-up PR to avoid blocking this one.

/unhold
/lgtm

cc @nickboldt

@openshift-ci openshift-ci bot added the lgtm label Nov 15, 2024
@rm3l
Copy link
Member

rm3l commented Nov 22, 2024

I think we should also update the instructions for AKS: docs.redhat.com/en/documentation/red_hat_developer_hub/1.3/html/installing_red_hat_developer_hub_on_microsoft_azure_kubernetes_service/proc-rhdh-deploy-aks-operator_title-install-rhdh-aks#proc-rhdh-deploy-aks-operator_title-install-rhdh-aks
Right now, the first step in this procedure is Obtain the Red Hat Developer Hub Operator manifest file, named rhdh-operator-<VERSION>.yaml [...] (with no information on how to obtain that manifest), then Apply the modified Operator manifest to your Kubernetes cluster. There is no mention of OLM there.
But the instructions to install the Operator with OLM should be quite similar on AKS and EKS (not sure if the last step on changing the Service Type to NodePort is needed on AKS).

FYI, I've created a follow-up JIRA to capture this: https://issues.redhat.com/browse/RHIDP-5032
I tried to update the instructions for AKS to require OLM. But since the OLM steps are quite similar, I think it might be worth refactoring and sharing the same OLM-related content for AKS and EKS, to avoid having a lot of duplicate content.

@hmanwani-rh @nickboldt Here is a quick draft PR (building on top of this one): #729
LMK if it makes sense. If not, no problem to close it, and let the docs team work on https://issues.redhat.com/browse/RHIDP-5032 later.

@openshift-ci
Copy link

openshift-ci bot commented Dec 2, 2024

New changes are detected. LGTM label has been removed.

@themr0c themr0c added Technical review done ⛅ Any procedure has been succesfully tested Ready to merge 💂 and removed Technical review needed 🔩 Test all the procedures labels Dec 9, 2024
@themr0c themr0c merged commit 03aa8cc into main Dec 9, 2024
3 checks passed
@themr0c themr0c deleted the RHIDP-2707_RHIDP-3497 branch December 9, 2024 09:57
@themr0c
Copy link
Member

themr0c commented Dec 9, 2024

/cherry-pick release-1.4

@openshift-cherrypick-robot
Copy link
Contributor

@nickboldt: new pull request created: #777

In response to this:

/cherry-pick release-1.3
/cherry-pick 1.2.x

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-sigs/prow repository.

@openshift-cherrypick-robot
Copy link
Contributor

@themr0c: new pull request created: #778

In response to this:

/cherry-pick release-1.4

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-sigs/prow repository.

@openshift-cherrypick-robot
Copy link
Contributor

@nickboldt: new pull request created: #779

In response to this:

/cherry-pick release-1.3
/cherry-pick 1.2.x

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-sigs/prow repository.

Gerry-Forde pushed a commit to Gerry-Forde/red-hat-developers-documentation-rhdh-v2 that referenced this pull request Dec 12, 2024
… quickstart (RHIDP-2707) (RHIDP-3497) (redhat-developer#700)

* chore(installation): remove doc about non-OLM instlalation method; add extra link to OLM quickstart at https://olm.operatorframework.io/docs/getting-started/ (RHIDP-2707) (RHIDP-3497)

Signed-off-by: Nick Boldt <[email protected]>

* Update modules/installation/proc-rhdh-deploy-eks-operator.adoc

Co-authored-by: Heena Manwani <[email protected]>

---------

Signed-off-by: Nick Boldt <[email protected]>
Co-authored-by: Heena Manwani <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Gerry-Forde added a commit that referenced this pull request Dec 16, 2024
…nctions to proxy backend (#766)

* RHIDP-4802 - Dynamic plugin: Document how users can add middleware functions to proxy backend

* RHIDP-4566: document how to manage PVCs in RHDH operator (#702)

* RHIDP-4566: document how to manage PVCs in RHDH operator

* Incorporated review suggestions

* Incorporate QE suggestion

* chore: dynamic plugins are all now expressed as wrappers (RHIDP-5103) (#753)

* chore: dynamic plugins are all now expressed as wrappers so we don't need to parse janus-plugins repo anymore

Signed-off-by: Nick Boldt <[email protected]>

* comment out the TP stuff and mark it with RHIDP-5103 so we can re-enable it if needed in future

Signed-off-by: Nick Boldt <[email protected]>

* regen content from showcase main branch

Signed-off-by: Nick Boldt <[email protected]>

* re-add missing community plugins

Signed-off-by: Nick Boldt <[email protected]>

* re-add missing community plugins (regen content)

Signed-off-by: Nick Boldt <[email protected]>

---------

Signed-off-by: Nick Boldt <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* RHIDP-4409: update metric monitoring instructions for OCP and AKS (#757)

* update metric monitoring instructions for OCP and AKS

Signed-off-by: Jessica He <[email protected]>

* modularized the content

---------

Signed-off-by: Jessica He <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Heena Manwani <[email protected]>

* added missing article (#741)

* chore: fix known issues search string (#774)

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* RHIDP-4805: RHBK v24 support for RHDH 1.4 (#767)

* RHBK v24 support for RHDH 1.4

* Added note

* review suggestions incorporated

* RHIDP-4572: Updating /metrics port (#735)

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* chore(installation): remove non-OLM installation doc; add link to OLM quickstart (RHIDP-2707) (RHIDP-3497) (#700)

* chore(installation): remove doc about non-OLM instlalation method; add extra link to OLM quickstart at https://olm.operatorframework.io/docs/getting-started/ (RHIDP-2707) (RHIDP-3497)

Signed-off-by: Nick Boldt <[email protected]>

* Update modules/installation/proc-rhdh-deploy-eks-operator.adoc

Co-authored-by: Heena Manwani <[email protected]>

---------

Signed-off-by: Nick Boldt <[email protected]>
Co-authored-by: Heena Manwani <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Add supported keycloak version

* Remove Audit log file rotation in RHDH

* RHIDP-4802 -  Dynamic plugin: Document how users can add middleware functions to proxy backend

* RHIDP-4802 - Dynamic plugin: Document how users can add middleware functions to proxy backend

---------

Signed-off-by: Nick Boldt <[email protected]>
Signed-off-by: Jessica He <[email protected]>
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Heena Manwani <[email protected]>
Co-authored-by: Nick Boldt <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Jessica He <[email protected]>
Co-authored-by: Heena Manwani <[email protected]>
Co-authored-by: Priyanka Abel <[email protected]>
Co-authored-by: jmagak <[email protected]>
otikhomi pushed a commit to otikhomi/red-hat-developers-documentation-rhdh that referenced this pull request Jan 20, 2025
…nctions to proxy backend (redhat-developer#766)

* RHIDP-4802 - Dynamic plugin: Document how users can add middleware functions to proxy backend

* RHIDP-4566: document how to manage PVCs in RHDH operator (redhat-developer#702)

* RHIDP-4566: document how to manage PVCs in RHDH operator

* Incorporated review suggestions

* Incorporate QE suggestion

* chore: dynamic plugins are all now expressed as wrappers (RHIDP-5103) (redhat-developer#753)

* chore: dynamic plugins are all now expressed as wrappers so we don't need to parse janus-plugins repo anymore

Signed-off-by: Nick Boldt <[email protected]>

* comment out the TP stuff and mark it with RHIDP-5103 so we can re-enable it if needed in future

Signed-off-by: Nick Boldt <[email protected]>

* regen content from showcase main branch

Signed-off-by: Nick Boldt <[email protected]>

* re-add missing community plugins

Signed-off-by: Nick Boldt <[email protected]>

* re-add missing community plugins (regen content)

Signed-off-by: Nick Boldt <[email protected]>

---------

Signed-off-by: Nick Boldt <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* RHIDP-4409: update metric monitoring instructions for OCP and AKS (redhat-developer#757)

* update metric monitoring instructions for OCP and AKS

Signed-off-by: Jessica He <[email protected]>

* modularized the content

---------

Signed-off-by: Jessica He <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Heena Manwani <[email protected]>

* added missing article (redhat-developer#741)

* chore: fix known issues search string (redhat-developer#774)

Signed-off-by: Fabrice Flore-Thébault <[email protected]>

* RHIDP-4805: RHBK v24 support for RHDH 1.4 (redhat-developer#767)

* RHBK v24 support for RHDH 1.4

* Added note

* review suggestions incorporated

* RHIDP-4572: Updating /metrics port (redhat-developer#735)

Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* chore(installation): remove non-OLM installation doc; add link to OLM quickstart (RHIDP-2707) (RHIDP-3497) (redhat-developer#700)

* chore(installation): remove doc about non-OLM instlalation method; add extra link to OLM quickstart at https://olm.operatorframework.io/docs/getting-started/ (RHIDP-2707) (RHIDP-3497)

Signed-off-by: Nick Boldt <[email protected]>

* Update modules/installation/proc-rhdh-deploy-eks-operator.adoc

Co-authored-by: Heena Manwani <[email protected]>

---------

Signed-off-by: Nick Boldt <[email protected]>
Co-authored-by: Heena Manwani <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>

* Add supported keycloak version

* Remove Audit log file rotation in RHDH

* RHIDP-4802 -  Dynamic plugin: Document how users can add middleware functions to proxy backend

* RHIDP-4802 - Dynamic plugin: Document how users can add middleware functions to proxy backend

---------

Signed-off-by: Nick Boldt <[email protected]>
Signed-off-by: Jessica He <[email protected]>
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Heena Manwani <[email protected]>
Co-authored-by: Nick Boldt <[email protected]>
Co-authored-by: Fabrice Flore-Thébault <[email protected]>
Co-authored-by: Jessica He <[email protected]>
Co-authored-by: Heena Manwani <[email protected]>
Co-authored-by: Priyanka Abel <[email protected]>
Co-authored-by: jmagak <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants