openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

OSDOCS-9725 ALBO Install Doc Procedure Updates 4.14-4.15

Open jmanthei opened this issue 1 year ago • 6 comments

Version(s): 4.14-4.15

Issue: https://issues.redhat.com/browse/OSDOCS-9725

Link to docs preview:

QE review:

  • [ ] QE has approved this change.

Additional information:

jmanthei avatar Mar 21 '24 19:03 jmanthei

Edited to correct: previously, versions have had different channels, but recently we updated dev/eng to accomodate for less docs changes. The channels are the same 4.12+ and they were the nuance we were correcting for.

Updated to add: there may be a slight variation re: credentialsrequest between 4.13 and 4.14 where 4.14 automatically creates the file but in 4.13 it needs to be manually updated.

jmanthei avatar Mar 21 '24 19:03 jmanthei

@ShudiLi can you QE check the CLI directions please

jmanthei avatar Mar 21 '24 19:03 jmanthei

🤖 Mon Apr 29 18:04:10 - Prow CI generated the docs preview:

https://73583--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/aws_load_balancer_operator/install-aws-load-balancer-operator.html

ocpdocs-previewbot avatar Mar 21 '24 19:03 ocpdocs-previewbot

/label peer-review-needed

jmanthei avatar Mar 25 '24 22:03 jmanthei

/lgtm thanks

ShudiLi avatar Mar 26 '24 06:03 ShudiLi

Direct link for preview: https://73583--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/aws_load_balancer_operator/install-aws-load-balancer-operator

JoeAldinger avatar Mar 26 '24 12:03 JoeAldinger

@jmanthei If this PR is only for 4.14, please update comment zero in the PR with the accurate version information. Please be aware, PRs merged into main must be merged into 4.16. So, if this PR is accurate for 4.14 through 4.16 (4.14+), then you can keep the base branch as main.

If this PR should be merged into only OCP 4.14, then you need to change your base branch. The instructions for how to do this is in the OpenShift docs manual: https://docs.google.com/document/u/2/d/e/2PACX-1vRLKWEMHQ3DZroxZKfTu3XcrSdREr6D3oSSayBanEprXhkA2Ciyr2SQuDTYI4aIKUiOPPIQMHgjHeh8/pub#h.5s75lq4bcdl5

Feel free to reach out if you need help.

michaelryanpeter avatar Mar 27 '24 15:03 michaelryanpeter

New changes are detected. LGTM label has been removed.

openshift-ci[bot] avatar Mar 29 '24 19:03 openshift-ci[bot]

@ShudiLi would you please check my edits and confirm the GUI direction change please?

jmanthei avatar Apr 03 '24 15:04 jmanthei

@alebedev87 please confirm my step-by-step breakdown is appropriate and correct

jmanthei avatar Apr 03 '24 19:04 jmanthei

ALBO-webConsole In https://73583--ocpdocs-pr.netlify.app/openshift-enterprise/latest/networking/aws_load_balancer_operator/install-aws-load-balancer-operator, it mentioned "Installation mode as A specific namespace on the cluster", the Installation mode should be "All namespaces on the cluster (default)", for "A specific namespace on the cluster" mode is not supported by this Operator

ShudiLi avatar Apr 18 '24 02:04 ShudiLi

I list the CLI commands and the yaml files to create the ALBO, in the PR, seemed missing CredentialsRequest for creating ALBO.

  1. oc apply -f namespace.yaml

% cat namespace.yaml

apiVersion: v1
kind: Namespace
metadata:
  name: aws-load-balancer-operator

%

  1. oc apply -f credentialsrequest.yaml % cat credentialsrequest.yaml
apiVersion: cloudcredential.openshift.io/v1
kind: CredentialsRequest
metadata:
  name: aws-load-balancer-operator
  namespace: openshift-cloud-credential-operator
spec:
  providerSpec:
    apiVersion: cloudcredential.openshift.io/v1
    kind: AWSProviderSpec
    statementEntries:
      - action:
          - ec2:DescribeSubnets
        effect: Allow
        resource: "*"
      - action:
          - ec2:CreateTags
          - ec2:DeleteTags
        effect: Allow
        resource: arn:aws:ec2:*:*:subnet/*
      - action:
          - ec2:DescribeVpcs
        effect: Allow
        resource: "*"
  secretRef:
    name: aws-load-balancer-operator
    namespace: aws-load-balancer-operator
  serviceAccountNames:
    - aws-load-balancer-operator-controller-manager

%

  1. oc apply -f operatorgroup.yaml

% cat operatorgroup.yaml

apiVersion: operators.coreos.com/v1
kind: OperatorGroup
metadata:
  name: aws-lb-operatorgroup
  namespace: aws-load-balancer-operator
spec:
  upgradeStrategy: Default

%

  1. oc apply -f subscription.yaml

% cat subscription.yaml

apiVersion: operators.coreos.com/v1alpha1
kind: Subscription
metadata:
  name: aws-load-balancer-operator
  namespace: aws-load-balancer-operator
spec:
  channel: stable-v1
  installPlanApproval: Automatic
  name: aws-load-balancer-operator
  source: qe-app-registry
  sourceNamespace: openshift-marketplace

%

  1. check the installPlan's status.phase oc -n aws-load-balancer-operator get sub aws-load-balancer-operator --template='{{.status.installplan.name}}{{"\n"}}' oc -n aws-load-balancer-operator get ip <install_plan_name> --template='{{.status.phase}}{{"\n"}}'

ShudiLi avatar Apr 18 '24 02:04 ShudiLi

oh, i just saw one of your earlier comments: if this is for 4.14 only, you will need to change the target branch you're merging into; merging into main requires merging into enterprise-4.16 branch. however, if the changes between them are small, you can open up a second PR to make the tweaks for the respective branches instead. up to you!

jldohmann avatar Apr 23 '24 19:04 jldohmann

Same comment also about clarifying which versions this PR is applicable for. It's currently marked for 4.12+. If you don't want it in 4.12 and 4.13 because there are things that need to be changed first, please update it to list only 4.14+, and take care of the other versions in separate PRs.

And also making sure that by your statement of "this is only for 4.14" that you mean 4.14+ (4.14, 4.15, and 4.16). If it really was ONLY for 4.14, then as Jesse mentioned above, this PR would have to be retargeted to only go directly into enterprise-4.14.

bergerhoffer avatar Apr 24 '24 22:04 bergerhoffer

Edited to correct: previously, versions have had different channels, but recently we updated dev/eng to accomodate for less docs changes. The channels are the same 4.12+ and they were the nuance we were correcting for.

@michaelryanpeter @jldohmann @bergerhoffer I have updated the title and hopefully this comment 1 clears up this issue. No weird cherrypicking for this one. :)

jmanthei avatar Apr 25 '24 16:04 jmanthei

/label peer-review-needed

jmanthei avatar Apr 26 '24 19:04 jmanthei

/remove-label peer-review-done

jmanthei avatar Apr 26 '24 19:04 jmanthei

@ShudiLi please review all the changes

jmanthei avatar Apr 26 '24 19:04 jmanthei

@jmanthei A few nits. Otherwise LGTM

mburke5678 avatar Apr 26 '24 21:04 mburke5678

@jmanthei: all tests passed!

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

openshift-ci[bot] avatar Apr 29 '24 18:04 openshift-ci[bot]

/cherrypick enterprise-4.12

mburke5678 avatar Apr 29 '24 20:04 mburke5678

/cherrypick enterprise-4.13

mburke5678 avatar Apr 29 '24 20:04 mburke5678

/cherrypick enterprise-4.14

mburke5678 avatar Apr 29 '24 20:04 mburke5678

/cherrypick enterprise-4.15

mburke5678 avatar Apr 29 '24 20:04 mburke5678

/cherrypick enterprise-4.16

mburke5678 avatar Apr 29 '24 20:04 mburke5678

@mburke5678: new pull request created: #75305

In response to this:

/cherrypick enterprise-4.12

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.

@mburke5678: new pull request created: #75306

In response to this:

/cherrypick enterprise-4.13

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.

@mburke5678: new pull request created: #75307

In response to this:

/cherrypick enterprise-4.14

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.

@mburke5678: new pull request created: #75308

In response to this:

/cherrypick enterprise-4.15

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.

@mburke5678: new pull request created: #75309

In response to this:

/cherrypick enterprise-4.16

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.