-
Notifications
You must be signed in to change notification settings - Fork 44
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
base: main
Are you sure you want to change the base?
[RHIDP-5032] Add procedure for deploying the Operator on AKS using OLM #729
Conversation
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-729/ @ 01/04/25 22:02:43 |
1c58b02
to
60038b3
Compare
.Additonal resources | ||
* For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation. |
There was a problem hiding this comment.
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:
.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)]. |
There was a problem hiding this comment.
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)
.Additonal resources | |
* For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
c3ae390
to
028158b
Compare
@themr0c Thanks for reviewing this. I've updated the PR based on your feedback. PTAL.
|
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? |
028158b
to
ddf9cf0
Compare
/cherry-pick release-1.3 |
@rm3l: once the present PR merges, I will cherry-pick it on top of 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-sigs/prow repository. |
…cedure-for-deploying-the-operator-on-aks-using-olm
…operator-on-aks-using-olm
…operator-on-aks-using-olm
There was a problem hiding this 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!
Co-authored-by: Lindsey Frazier <[email protected]>
…operator-on-aks-using-olm
Co-authored-by: Lindsey Frazier <[email protected]>
Welcome back and thanks for the review, @linfraze !! I've incorporated your suggestions. PTAL. Thanks. |
/assign @linfraze |
There was a problem hiding this 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: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
. 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
== 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)]. |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
#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), thenApply 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-aksIMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s):
Add the relevant labels to the Pull Request.
Issue:
https://issues.redhat.com/browse/RHIDP-5032
Preview: