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.

Sign up for GitHub

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

Jump to bottom

[BOP-653] Add config flag to upgrade docs #13

Merged
merged 2 commits into from
May 16, 2024
Merged

[BOP-653] Add config flag to upgrade docs #13

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
efaf5c6
updated upgrade docs; fixed broken links
byDimasik May 16, 2024
6f54100
fixed link inspector
byDimasik May 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/.linkspector.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
dirs:
- ../content/
- ./content/

useGitIgnore: true
useGitIgnore: true
3 changes: 1 addition & 2 deletions .github/workflows/PR.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ jobs:
- name: Run linkspector
uses: umbrelladocs/action-linkspector@v1
with:
github_token: ${{ secrets.PAT_CI_BOUNDLESS }}
reporter: local
reporter: github-pr-check
fail_on_error: true
config_file: .github/.linkspector.yml
3 changes: 1 addition & 2 deletions content/docs/setup/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@
[Releases](https://github.com/MirantisContainers/mke/releases) page of the MKE 4 repository.

`mkectl` is supposed to be a single binary capable of managing MKE 4 clusters without any additional dependencies.
However, as of version `0.0.5`, it still requires the following tools to be installed on your system:
However, as of commit `e19af33`, it still requires the following tools to be installed on your system:

- `kubectl` of version `1.29.0` or above ([download](https://kubernetes.io/docs/tasks/tools/#kubectl))
- `k0sctl` of version `0.17.0` or above ([download](https://github.com/k0sproject/k0sctl/releases))
- `bctl` of version `1.0.0-rc.1` or above ([download](https://github.com/MirantisContainers/boundless-cli/releases))
5 changes: 5 additions & 0 deletions content/docs/setup/upgrade-from-mke-3/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,18 @@ Users can upgrade from MKE 3 to MKE 4 using the `mkectl` tool. The `mkectl` tool
- Migrate manager nodes to k0s.
- Migrate worker nodes to k0s.
- Perform post upgrade cleanup to remove MKE 3 components.
- Output the new MKE 4 config file.

To upgrade an MKE 3 cluster, run the following command:

```shell
mkectl upgrade --hosts-path <path-to-hosts-yaml> --admin-username <admin-username> --admin-password <admin-password>
```

> If you don't specify `--config-out` flag, the MKE 4 config file will be printed to the console
after the migration is complete. You can save this output to a file for future use with `mkectl apply`.
<br>Alternatively, you can set `--config-out` to the path where you want to save the MKE 4 config file.

- The upgrade process will take some time to complete. After the upgrade is complete, verify that the MKE 4 cluster is running:

```shell
Expand Down
4 changes: 3 additions & 1 deletion content/releases/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@


### Setup
[Fresh Install](../docs/setup/install/README.md)
[Install mkectl](../docs/setup/README.md)

[Install MKE 4](../docs/setup/getting-started/README.md)

[Upgrade from MKE 3](../docs/setup/upgrade-from-mke-3/README.md)

Expand Down