[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/14/25 11:07:16 |
rm3l
force-pushed
the
RHIDP-5032--add-procedure-for-deploying-the-operator-on-aks-using-olm
branch
from
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.
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.
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.
Based on your feedback, I've updated this and removed the leftovers:
rm3l
force-pushed
the
RHIDP-5032--add-procedure-for-deploying-the-operator-on-aks-using-olm
branch
from
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? |
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.
@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.
| == 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.
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.
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?
There was a problem hiding this comment.
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.
[...]
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.
@linfraze Installing the Red Hat Developer Hub Operator is really specific to OCP in my opinion. It leverages the OCP web console, which is not available on non-OCP platforms. Also, the prerequisites are different on OCP vs AKS/GKE/EKS. For example, OLM is already available OOTB on OCP, but needs to be installed on the other platforms. Same point for pulling images from registry.redhat.io.
So I am not sure we can reuse that content from there.
I think it could have been possible if we had a procedure for installing the Operator on OCP from the CLI.
Did I miss anything?
There was a problem hiding this comment.
Hm, good to note about the CLI Operator install...
I did notice a lot more Prerequs for AKS/EKS than for OCP.
While we do need to put this new AKS/EKS-specific procedure in a separate, reusable file so that we adhere to modularity and single-sourcing best practices, I want to hear others' thoughts (@Preeticp) on whether we let this PR go out as-is and then open a new PR that creates and includes a separate proc file for installing the Operator for AKS/EKS or if we should go ahead and correct it now.
…operator-on-aks-using-olm
Co-authored-by: Lindsey Frazier <[email protected]>
…g would show up under the Verification section
rm3l
force-pushed
the
RHIDP-5032--add-procedure-for-deploying-the-operator-on-aks-using-olm
branch
from
2915a63 to
c713eae
Compare
…operator-on-aks-using-olm
|
The subject matter of this content is very helpful and needed, but the overall structure and metadata needs some correction. It might be best if a member of the docs team authored this content with the proper structure, adoc, and CCS best practices while collaborating with @rm3l to ensure that it remains technically accurate. |
|
@rm3l this content covers a gap in our docs for AKS/GKE/EKS users and is super useful, thank you! |
|
That makes sense - thanks @linfraze @Preeticp ! |
|
/close |
|
@rm3l: Closed this PR. 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. |
#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-aksAlso, because these instructions are quite similar on AKS, EKS and GKE, it tries to reuse the same content as much as possible.
IMPORTANT: 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: