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

[DOC] Edit setup content initial #16

Merged
merged 17 commits into from
Jun 11, 2024

Conversation

KoryKessel-Mirantis
Copy link
Collaborator

Initial edit of MKE 4 Setup content, including text changes and content restructuring/granulation.

@KoryKessel-Mirantis KoryKessel-Mirantis changed the title Edit setup content initial [DOC] Edit setup content initial May 29, 2024
@KoryKessel-Mirantis KoryKessel-Mirantis removed the request for review from byDimasik June 6, 2024 16:51
Copy link
Collaborator

@nwneisen nwneisen left a comment

Choose a reason for hiding this comment

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

A few comments but looks good overall

content/docs/setup/getting-started/installation.md Outdated Show resolved Hide resolved
content/docs/setup/getting-started/installation.md Outdated Show resolved Hide resolved
content/docs/setup/getting-started/installation.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@sakshisharma84 sakshisharma84 left a comment

Choose a reason for hiding this comment

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

Thanks for addressing the comments. Looks good!

Comment on lines 1 to 2


Copy link
Contributor

Choose a reason for hiding this comment

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

Remove empty lines

@@ -0,0 +1,45 @@


## Using the cluster
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
## Using the cluster
# Using the cluster


- Set the KUBECONFIG env var to point to `~/.mke/mke.kubeconfig`

Example:
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove, other methods don't have it.

Comment on lines 15 to 17
```shell
`export KUBECONFIG=~/.mke/<cluster name>.kubeconfig`
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
```shell
`export KUBECONFIG=~/.mke/<cluster name>.kubeconfig`
```
```shell
`export KUBECONFIG=~/.mke/<cluster name>.kubeconfig`

Comment on lines 27 to 29
```shell
`kubectl --kubeconfig ~/.mke/mke.kubeconfig`
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
```shell
`kubectl --kubeconfig ~/.mke/mke.kubeconfig`
```
```shell
`kubectl --kubeconfig ~/.mke/mke.kubeconfig`
It was not rendering correctly

Comment on lines 1 to 3
# Upgrade from MKE 3 to MKE 4

## Prerequisites
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
# Upgrade from MKE 3 to MKE 4
## Prerequisites
# Upgrade prerequisites


## Prerequisites

Verify that you have the following components in place before you begin the upgrade process:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Verify that you have the following components in place before you begin the upgrade process:
Verify that you have the following components in place before you begin the MKE 3 to MKE 4 upgrade process:


```shell
kubectl get nodes
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Add empty line between code samples

```shell
version: v0.17.4
commit: 372a589
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Add empty line after the code sample

commit: 372a589
```
- A `hosts.yaml` file, to provide the information required by `mkectl` to
connect to each node by way of SSH.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
connect to each node by way of SSH.
connect to each node with SSH.

```
aws ec2 describe-instances --region $(grep "region" terraform.tfvars | awk -F' *= *' '{print $2}' | tr -d '"')
```
Alternatively, you can get a visual overview of the VMs at the AWS EC2 page
Copy link
Contributor

Choose a reason for hiding this comment

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

Add an empty line after the code block

@KoryKessel-Mirantis KoryKessel-Mirantis merged commit c8cff1d into main Jun 11, 2024
2 checks passed
@KoryKessel-Mirantis KoryKessel-Mirantis deleted the edit-setup-content-initial branch June 11, 2024 13:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants