-
Notifications
You must be signed in to change notification settings - Fork 207
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
Add aws out of tree cloud provider install/upgrade docs #844
Conversation
I'm holding off on reviewing this because it copy/pastes from another PR that is currently in review and needs to be updated. Changes applied to that PR will also have to be applied here. |
f31d9de
to
930a401
Compare
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.
I have the same review comments as the original PR. I think it should be made clear to the user why they need to move and the install charts steps need verification commands so the user can reliably know that it is running versus thinking it is running.
@jakefhyde /@kinarashah , Would one of you be able to address Seb's feedback above? After that, the docs team will do an another round of review. Thanks. |
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.
some updates after going through this myself for the first time
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
one more thing discussed offline, but there is some issue either with the plugin or with some of these steps, as part of cleaning up an LB instance is deleting the previously created SG with it. However, I see that there is a problem deleting the SG and thus makes deleting LBs take much longer than expected. This also affects LBs created after trying to delete one, as it seems that the Final note: Typically the CSI install follows this chart's install, and i was able to install it with no modifications: https://github.com/kubernetes-sigs/aws-ebs-csi-driver we may want to add that note to these docs |
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.
rke2 migration seems to require a cluster update on steps 1, 3, and 5. Can this be explicitly called out for posterity?
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
1fa88f1
to
55ed809
Compare
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.
some small comments left to resolve
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
55ed809
to
dbcf171
Compare
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
@martyav @snasovich apologies, found 2 last things to update when testing. Pushed a commit to update. |
@kinarashah Thanks. I'll version the pages (copy changes over to the files in versioned_docs/version-2.8) and then merge |
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
…netes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
@snasovich Since this PR includes files in the /docs directory (which is the default users see when looking at an "unversioned" url), we're going to wait to merge until the day of the release. The other option is to revert the changes in /docs, keep the changes in versioned_docs/version-2.8, then sync /docs with /version-2.8 the day of the merge. The first option seems less complicated and confusing imo. |
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.
I see multiples instances of:
### Helm Chart Installation from CLI
on line 222 and 609### Helm Chart Installation from UI
on line 359 and 740
Are these duplicates or are they intended to be structured like the below?
- Using the Out-of-tree AWS Cloud Provider for RKE1
- Helm Chart Installation from CLI
- Helm Chart Installation from UI
- Using the Out-of-tree AWS Cloud Provider for RKE2
- Helm Chart Installation from CLI
- Helm Chart Installation from UI
kubectl rollout status daemonset -n kube-system aws-cloud-controller-manager | ||
``` | ||
|
||
### Using Out-of-tree AWS Cloud Provider for RKE2 |
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.
### Using Out-of-tree AWS Cloud Provider for RKE2 | |
### Using the Out-of-tree AWS Cloud Provider for RKE2 |
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.
I was reviewing the document again in order to work towards the reorganization of the "Set up Cloud Providers" section proposed, and there's a very large duplicated section from 427 to 510. I'm currently editing the file to fix the issue
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
...guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md
Outdated
Show resolved
Hide resolved
This partially addresses #991 (rename file `migrating-from-in-tree-to-out-of-tree` to shorter and reference vsphere) and also fixes problems on the open PR: Duplicate sections (removed), difficulty navigating the file (split into two), sections with similar titles (opting for tabs instead of headings). I created this on its own working branch because moving around large blocks of text was unwieldly and I didn't want to mess up my local version of 763-document-aws-out-of-tree-v2prov. The last tab block (Helm Chart Installation through UI) contains contain that seems to be entirely the same for RKE and RKE2.
* Clarify "Linux dependencies" for vSphere * Add note regarding rancher pentest reports public availability (#961) * Add note regarding rancher pentest reports public availability This PR will add a note regarding third-party penetration test reports public disclosure. * Update docs/pages-for-subheaders/rancher-security.md * versioning for 2.7, 2.8 * added back in webhook material at end of 2.8 page * corrected broken link --------- Co-authored-by: Pietro Dell'Amore <[email protected]> Co-authored-by: Marty Hernandez Avedon <[email protected]> * Add redirects for dashboard links * Updates to the Global roles for new 2.8 features (#898) * Updating docs to deprecate Restricted Admin * Updating GlobalRole Docs Updates the docs for GlobalRoles to include new info on the "escalate" and "bind" verbs, as well as include info on how to use the new "inheritedClusterRoles" field * Apply suggestions from code review * code review changes * merged some minor copyedits * Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md * Update docs/how-to-guides/new-user-guides/authentication-permissions-and-global-configuration/manage-role-based-access-control-rbac/global-permissions.md * fixed versioning for v2.8, v2.7 * Update docs/getting-started/installation-and-upgrade/installation-references/helm-chart-options.md * copy/paste current version of global-permissions file in main to ensure file is correctly reverted to v2.7 --------- Co-authored-by: Marty Hernandez Avedon <[email protected]> * #857 Add a API quickstart page under the (to be added) API section (#858) * initial engineering draft of api quickstart * spacing, headings * copyedit * note syntax added for last warning * link to create api keys page, copy edits * formating * Apply suggestions from code review Co-authored-by: Billy Tat <[email protected]> * indentation, intro * Update docs/api/quickstart.md Co-authored-by: Billy Tat <[email protected]> * Apply suggestions from code review Co-authored-by: Michael Bolot <[email protected]> * Update docs/api/quickstart.md * removed commented-out line * moved text from step 5 to step 3, made into its own step, added info about not all resources offering detailed output * added sidebar entry * mv'd to version-2.8 dir * rm'd remainders in /docs dir --------- Co-authored-by: Billy Tat <[email protected]> Co-authored-by: Michael Bolot <[email protected]> * Fix version-2.8 broken links * Update header: More from SUSE * Fix quoting (single vs double) consistency * Fix link rendering issue * Add 2.7.9 entry to versions table * Add initial Opni landing page Signed-off-by: Mike Latimer <[email protected]> * added color icons to /static/img * Add K8s Distro landing page content * added css + elemental icon * rm'd temp file * Update src/css/custom.css Co-authored-by: Billy Tat <[email protected]> * rm usused icons * canonical links for single-user-nodes and user-settings * Update token setting page (#906) * Update token setting page * Remove unnecessary step * Harvester landing page: apply feedback from #940 * Rancher Desktop landing page: apply feedback from #944 * Epinio landing page: apply feedback from #945 * fixed spacing problem that ruined callout (#978) * rm mention of Rio from 2.7 & 2.8 (#980) * General FAQ copyedit (#983) * General FAQ copyedit * restored intro * Update etcd troubleshoot for etcd 3.5.7 and higher (#985) * Add session management section (#981) * Add note regarding rancher pentest reports public availability This PR will add a note regarding third-party penetration test reports public disclosure. * Add session management section to rancher security best practices This PR will create a new section inside Rancher Security Best Practices adding security recommendations for RM deployments that might need additional security controls. * Apply suggestions from code review Co-authored-by: Paulo Gomes <[email protected]> * Update docs/reference-guides/rancher-security/rancher-security-best-practices.md * Update docs/reference-guides/rancher-security/rancher-security-best-practices.md Co-authored-by: Guilherme Macedo <[email protected]> * versioned docs --------- Co-authored-by: Pietro Dell'Amore <[email protected]> Co-authored-by: Marty Hernandez Avedon <[email protected]> Co-authored-by: Paulo Gomes <[email protected]> Co-authored-by: Guilherme Macedo <[email protected]> * #879 Add Project Owner to 'Project Member Can't Create Namespace' doc (#894) * 879 Add Project Owner to 'Project Member Can't Create Namespace' doc * versioned doc * Update docs/reference-guides/rancher-webhook.md Co-authored-by: Billy Tat <[email protected]> * Update docs/reference-guides/rancher-webhook.md Co-authored-by: Michael Bolot <[email protected]> * Apply suggestions from code review Co-authored-by: Lucas Saintarbor <[email protected]> * Update docs/reference-guides/rancher-webhook.md * page sync * added v2.8 page * merge syntax left in file, rm'd backticks from version numbers --------- Co-authored-by: Billy Tat <[email protected]> Co-authored-by: Michael Bolot <[email protected]> Co-authored-by: Lucas Saintarbor <[email protected]> * 135 cloud-provider(aws): Need to correct content on cluster id in aws tagging section * versioning * Add delete permission and remove duplicate header (#989) * Apply suggestions from code review Co-authored-by: Billy Tat <[email protected]> * Amazon only uses EC2, so 'use anything' is a moot point * Update CNI popularity chart numbers. Credit to @amitmavgupta for original PR. * Update Swagger file * Fix etcd.backup_config.retention description * Add Projects API workflow example * Add project workflow to sidebar; remove duplicate API category * Update versioned_docs/version-2.8/api/workflows/projects.md Co-authored-by: Marty Hernandez Avedon <[email protected]> * #963 clarify documentation for read only permissions in monitoring UI (#964) * 963 - Clarify documentation around read-only permissions for monitoring. * fixed random Capitalization of Nouns * moved changes to v2.8 dir and revised capitalization again * Update docs/integrations-in-rancher/monitoring-and-alerting/rbac-for-monitoring.md * copyedits, added workaround * copyedits * versioning * Update versioned_docs/version-2.8/api/workflows/projects.md * Update migrate-rancher-to-new-cluster.md (#1007) * Update migrate-rancher-to-new-cluster.md * Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md * Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md * Update docs/how-to-guides/new-user-guides/backup-restore-and-disaster-recovery/migrate-rancher-to-new-cluster.md * 2.7, 2.8 versioning * restoring bulleted links to rke/k3s * 2.5 to 2.8 synced * rm'd info about rke2/k3s from inappropriate version * reverted last commit -- done by mistake --------- Co-authored-by: Marty Hernandez Avedon <[email protected]> * fix: update v2.7 cn sidebar * fixed typo in command (#1010) * Apply 4b2f812 (sidebar label update) to other versions. Originally changed in #926 * Remove term from translated sidebar label to match English label * #420 Completes canonical links task (#1011) * Completes canonical links task * spacing * Updating CSP Adapter versions * embed video on aws marketplace page (#1016) * Port version-2.8 updates to latest (/docs) (#1013) * Port version-2.8 updates to latest (/docs) Includes changes from 1b6d950 (2023-10-06) to 1f39a6f (2023-11-30) * Fix redirects * #773: Add steps to install Rancher Extensions in an air-gapped environment (#807) * Add steps to install Rancher Extensions in an air-gapped environment * added link from install guide * added notes to import/install steps as suggested by rohitsakala * minor copyedits * updating extensions explicitly given own section * tightened up note * updated note for v2.7 * ensuring all 3 versions have same text * versioning install-rancher-ha * del extension repos + (partially) upgrade * fixed comment syntax * Apply suggestions from code review Co-authored-by: Billy Tat <[email protected]> * Apply suggestions from code review * completed update instructions * no dropdown, text input * more explanation + delete * Apply suggestions from code review * extensions repo container image delete * versioning * revert changes to v2.7 --------- Co-authored-by: Billy Tat <[email protected]> * Add aws out of tree cloud provider install/upgrade docs (#844) * Add aws out of tree cloud provider install/upgrade docs * Add aws out of tree cloud provider install/upgrade docs * Add info for aws cloud provider * indentation fix * Address review comments * addressing review comments * Address review comments * syntax annotations, re-org sections, copy edits * even more copy edits * copy edits to note at top * addressing suggestions from slickwarren * Address review comments * copyedits * Fix numbering * Update docs/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md * update helm installation steps * 2.8 versioning * rm 'new in 2.7' from 2.8 * Update versioned_docs/version-2.8/how-to-guides/new-user-guides/kubernetes-clusters-in-rancher-setup/set-up-cloud-providers/amazon.md * revert -- change intended for other branch * typo fixes * fix headings, fix casing * apply prev commit to 2.8 * Reorganizing AWS migration pages (#1015) This partially addresses #991 (rename file `migrating-from-in-tree-to-out-of-tree` to shorter and reference vsphere) and also fixes problems on the open PR: Duplicate sections (removed), difficulty navigating the file (split into two), sections with similar titles (opting for tabs instead of headings). I created this on its own working branch because moving around large blocks of text was unwieldly and I didn't want to mess up my local version of 763-document-aws-out-of-tree-v2prov. The last tab block (Helm Chart Installation through UI) contains contain that seems to be entirely the same for RKE and RKE2. --------- Co-authored-by: Kinara Shah <[email protected]> Co-authored-by: martyav <[email protected]> * Add 2.8 entry to versions table (#1002) * Update webhook version table (#1006) * Update webhook version table * Bump 2.8 webhook version * Sync 2.8 table with latest table * Bump webhook version * correcting capitalization: helm > Helm (#1018) * Remove preview label from 2.8 * Remove unreleased banner * rm 'add additional' phrase from docs (#1020) * rm 'add additional' phrase from docs * these > more * rm deprecation banner from v2.8 * rm deprecation banner from v2.8 (#1023) * [skip ci] Update README to reflect current versioning model (#1022) * [skip ci] Update README to reflect current versioning model * Update README.md * Update README.md --------- Co-authored-by: Marty Hernandez Avedon <[email protected]> * Apply suggestions from code review * Update create-a-vm-template.md * Update create-a-vm-template.md * versioning --------- Signed-off-by: Mike Latimer <[email protected]> Co-authored-by: pdellamore <[email protected]> Co-authored-by: Pietro Dell'Amore <[email protected]> Co-authored-by: Marty Hernandez Avedon <[email protected]> Co-authored-by: Billy Tat <[email protected]> Co-authored-by: Michael Bolot <[email protected]> Co-authored-by: Mike Latimer <[email protected]> Co-authored-by: Marty Hernandez Avedon <[email protected]> Co-authored-by: Jonathan Crowther <[email protected]> Co-authored-by: Sebastiaan van Steenis <[email protected]> Co-authored-by: Paulo Gomes <[email protected]> Co-authored-by: Guilherme Macedo <[email protected]> Co-authored-by: Lucas Saintarbor <[email protected]> Co-authored-by: Denise <[email protected]> Co-authored-by: [yzeng25] <[[email protected]]> Co-authored-by: Jake Hyde <[email protected]> Co-authored-by: Kinara Shah <[email protected]>
Also associated with #814 |
Fixes #763
I copied a lot of what Kinara wrote in #826 wholesale.
This PR is ready for review and supersedes #826.
For rancher/rancher#42749