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

Upgrade command doc changes #495

Merged
merged 2 commits into from
Oct 28, 2021
Merged

Conversation

mitalipaygude
Copy link
Member

Issue #, if available:

Description of changes:
Upgrade command doc changes

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@abhay-krishna
Copy link
Member

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mitalipaygude

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@abhay-krishna abhay-krishna added approved size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 26, 2021
@g-gaston g-gaston linked an issue Oct 26, 2021 that may be closed by this pull request
@g-gaston g-gaston linked an issue Oct 26, 2021 that may be closed by this pull request
@@ -8,7 +8,8 @@ description: >
---
EKS Anywhere provides the command `upgrade`, which allows you to `upgrade` various aspects of your EKS Anywhere cluster.
When you run `eksctl anywhere upgrade cluster -f ./cluster.yaml`, EKS Anywhere runs a set of preflight checks to ensure your cluster is ready to be upgraded.
EKS Anywhere then performs the upgrade, modifying your cluster to match the updated specification.
EKS Anywhere then performs the upgrade, modifying your cluster to match the updated specification. The upgrade command also upgrades core components of EKS
Copy link
Contributor

Choose a reason for hiding this comment

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

One thing we do with the docs is every sentence should be on its own line. This makes diffs and changes easier to view and comment on.

The rendered markdown won't have line breaks but it helps a lot for long lines like this and paragraphs like you have further down in this doc.

* Cert-manager
* Etcdadm CAPI provider
* EKS Anywhere controllers and CRDs
* Flux
Copy link
Contributor

Choose a reason for hiding this comment

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

We generally call this the "gitops" controller. I'm not sure where else we reference it as "flux" specifically. We may also want to point out this is an optional component and not core.

@rothgar
Copy link
Contributor

rothgar commented Oct 28, 2021

/lgtm

@abhay-krishna abhay-krishna merged commit 3b1f771 into aws:main Oct 28, 2021
@mitalipaygude mitalipaygude deleted the upgrade_docs branch November 10, 2021 01:03
rothgar pushed a commit to rothgar/eks-anywhere that referenced this pull request Nov 20, 2021
* Upgrade command doc changes

* minor edits
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved lgtm size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs for new upgrade cluster command's behavior
3 participants