Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RHIDP-5032] Add procedure for deploying the Operator on AKS using OLM #729

Open
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

rm3l
Copy link
Member

@rm3l rm3l commented Nov 22, 2024

#700 clarified that the Operator installation requires OLM. As such, it removed the non-OLM steps for deploying the operator on EKS.

As raised in #700 (review), this PR updates the instructions for AKS accordingly by adding the missing OLM steps for 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. See 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

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s):

  • 1.4
  • 1.3

Add the relevant labels to the Pull Request.

Issue:
https://issues.redhat.com/browse/RHIDP-5032

Preview:

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Nov 22, 2024

@rm3l rm3l force-pushed the RHIDP-5032--add-procedure-for-deploying-the-operator-on-aks-using-olm branch from 1c58b02 to 60038b3 Compare November 22, 2024 14:28
Comment on lines 9 to 10
.Additonal resources
* For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation.
Copy link
Member

Choose a reason for hiding this comment

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

To respect modular docs templates, and for minimalism:

Suggested change
.Additonal resources
* For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation.
.Prerequisites
* You installed the Operator Lifecycle Manager (OLM) framework. See link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)].

Copy link
Member

@themr0c themr0c Nov 28, 2024

Choose a reason for hiding this comment

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

Or it seems, leftovers? (present at line 22)

Suggested change
.Additonal resources
* For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation.

Copy link
Member Author

Choose a reason for hiding this comment

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

Based on your feedback, I've updated this and removed the leftovers:

image

@rm3l rm3l force-pushed the RHIDP-5032--add-procedure-for-deploying-the-operator-on-aks-using-olm branch from c3ae390 to 028158b Compare December 3, 2024 12:04
@rm3l
Copy link
Member Author

rm3l commented Dec 3, 2024

@themr0c Thanks for reviewing this. I've updated the PR based on your feedback. PTAL.

PS: Since this PR is based on #700, I think we can probably close #700. This way, this PR would fix both https://issues.redhat.com/browse/RHIDP-2707 and https://issues.redhat.com/browse/RHIDP-5032. Or you can merge #700 first and I'll rebase this one. Up to you ;-)

@rm3l
Copy link
Member Author

rm3l commented Dec 3, 2024

BTW, any idea why the text preview on https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-729/install-rhdh-aks/#proc-rhdh-deploy-aks-operator_title-install-rhdh-aks is in italic?
I thought it was an issue in this PR, but it also happens on the main branch - see https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/main/admin-rhdh/
image
Is that expected?

@themr0c themr0c self-assigned this Dec 9, 2024
@rm3l rm3l force-pushed the RHIDP-5032--add-procedure-for-deploying-the-operator-on-aks-using-olm branch from 028158b to ddf9cf0 Compare December 9, 2024 10:14
@rm3l rm3l changed the title [WIP][RHIDP-5032] Add procedure for deploying the Operator on AKS using OLM [RHIDP-5032] Add procedure for deploying the Operator on AKS using OLM Dec 9, 2024
@rm3l
Copy link
Member Author

rm3l commented Dec 9, 2024

/cherry-pick release-1.3

@openshift-cherrypick-robot
Copy link
Contributor

@rm3l: 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.

@rm3l rm3l marked this pull request as ready for review December 9, 2024 10:40
…cedure-for-deploying-the-operator-on-aks-using-olm
Copy link
Member

@linfraze linfraze left a comment

Choose a reason for hiding this comment

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

Thank you for the content!

modules/installation/proc-deploy-rhdh-instance-eks.adoc Outdated Show resolved Hide resolved
modules/installation/proc-rhdh-deploy-aks-operator.adoc Outdated Show resolved Hide resolved
modules/installation/snip-install-rhdh-operator-olm.adoc Outdated Show resolved Hide resolved
modules/installation/snip-install-rhdh-operator-olm.adoc Outdated Show resolved Hide resolved
modules/installation/snip-install-rhdh-operator-olm.adoc Outdated Show resolved Hide resolved
modules/installation/snip-install-rhdh-operator-olm.adoc Outdated Show resolved Hide resolved
modules/installation/snip-install-rhdh-operator-olm.adoc Outdated Show resolved Hide resolved
Co-authored-by: Lindsey Frazier <[email protected]>
@rm3l
Copy link
Member Author

rm3l commented Jan 4, 2025

Welcome back and thanks for the review, @linfraze !! I've incorporated your suggestions. PTAL. Thanks.

@rm3l rm3l requested review from linfraze and themr0c January 4, 2025 22:07
@rm3l
Copy link
Member Author

rm3l commented Jan 4, 2025

/assign @linfraze

Copy link
Member

@linfraze linfraze left a comment

Choose a reason for hiding this comment

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

@rm3l thanks for the updates! I did catch a couple other things - a minor attribute replacement but also something more major:

We need to take a look at the Installing the Red Hat Developer Hub Operator procedure to see if it can be reused in this procedure as-is. We want to single-source whenever possible. Regardless of whether the existing procedure can go straight in here or needs to be rewritten, we need to insert a separate procedure module rather than insert the procedure for installing the Operator as a sub-heading within the procedure for Deploying on AKS at Line 9 -- We would ideally want to structure this procedure to be consistent with how the Installing RHDH on OCP doc is structured. We can chat about this in the next Install WG meeting, too, if needed.


.Procedure

. Create an Image Pull Secret named `rhdh-pull-secret` using your Red Hat credentials to access images from the protected `registry.redhat.io` as shown in the following example:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
. Create an Image Pull Secret named `rhdh-pull-secret` using your Red Hat credentials to access images from the protected `registry.redhat.io` as shown in the following example:
. Create an Image Pull Secret named `rhdh-pull-secret` using your {companyname} credentials to access images from the protected `registry.redhat.io` as shown in the following example:

replace company / product names with attribute

Comment on lines +9 to +17
== Installing the {product-short} Operator

.Prerequisites

* You have cluster-scoped privileges.
* You have set the context to the {aks-short} cluster in your current `kubeconfig`. For more information, see https://learn.microsoft.com/en-us/azure/aks/learn/quick-kubernetes-deploy-cli#connect-to-the-cluster[Connect to the cluster].
* You have installed `kubectl`. For more information, see https://learn.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-install-cli[`az aks install-cli`].
* You have subscribed to `registry.redhat.io`. For more information, see https://access.redhat.com/RegistryAuthentication[{company-name} Container Registry Authentication].
* You installed the Operator Lifecycle Manager (OLM) framework. See link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)].
Copy link
Member

Choose a reason for hiding this comment

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

We already have a separate procedure module for this that is applicable to OCP, EKS, and AKS but is currently only used in the OCP doc. We need to insert it here with metadata rather than rewrite it here this way.

See Installing the Red Hat Developer Hub Operator for example

I will also locate and find the proc file that needs to be inserted / reviewed. If it turns out that the existing file cannot be reused as-is, we must address that.

Copy link
Member

@linfraze linfraze Jan 6, 2025

Choose a reason for hiding this comment

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

proc-install-operator is the file that needs to be inserted with includes metadata.

@rm3l can you please review it and let me know if there is anything that needs to be updated for AKS or if it can be used as-is?

https://github.com/redhat-developer/red-hat-developers-documentation-rhdh/blob/main/modules/installation/proc-install-operator.adoc

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.

5 participants