From e1a3af674ce2fefdff047fd33fe7d64ef576be45 Mon Sep 17 00:00:00 2001 From: Aleksei Sizov <45825279+a13x5@users.noreply.github.com> Date: Fri, 3 Jan 2025 20:38:28 -0500 Subject: [PATCH] Repository rename related changes (#73) --- README.md | 20 ++++++++++--------- .../aws/hosted-control-plane.md | 2 +- docs/credential/main.md | 2 +- docs/index.md | 2 +- docs/quick-start/2a-installation.md | 2 +- .../template/pre-defined-service-templates.md | 2 +- docs/usage/2a-upgrade.md | 12 +++++------ docs/usage/installation.md | 8 ++++---- mkdocs.yml | 4 ++-- 9 files changed, 28 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index cdfcf8b..cfa90b5 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,19 @@ -# Project 2A Documentation +# K0rdent Documentation -The home of the consolidated documentation for Project 2A sponsored by Mirantis. -Project 2A may be referred to as Project 0x2A in the documentation due to legacy reasons. +The home of the consolidated documentation for K0rdent sponsored by Mirantis. +K0rdent may be referred to as Project 2A or Project 0x2A in the documentation +due to legacy reasons. -[Project 2A Docs](https://mirantis.github.io/project-2a-docs/) +[K0rdent Docs](https://k0rdent.github.io/docs) -This project utilises Mkdocs with the Material theme and Mermaid for diagrams. Currently -the docs are published using github actions on github pages from the branch gh-pages. +This project utilises Mkdocs with the Material theme and Mermaid for +diagrams. Currently the docs are published using github actions on github pages +from the branch gh-pages. -Development is tracked under [Project 2A](https://github.com/orgs/Mirantis/projects/8) on github. +Development is tracked under [K0rdent](https://github.com/orgs/Mirantis/projects/8) on github. -The related Project 2A repositories can be found as follows: - * [HMC](https://github.com/Mirantis/hmc) +The related K0rdent repositories can be found as follows: + * [HMC](https://github.com/k0rdent/kcm) ## Project layout diff --git a/docs/clustertemplates/aws/hosted-control-plane.md b/docs/clustertemplates/aws/hosted-control-plane.md index b1b3cc1..517e9f7 100644 --- a/docs/clustertemplates/aws/hosted-control-plane.md +++ b/docs/clustertemplates/aws/hosted-control-plane.md @@ -141,7 +141,7 @@ kubectl get awscluster cluster -o go-template="$(cat managedcluster.yaml.tpl)" > the `kubeconfig` from the cluster and run the commands: ``` -KUBECONFIG=kubeconfig IMG="ghcr.io/mirantis/hmc/controller-ci:v0.0.1-179-ga5bdf29" REGISTRY_REPO="oci://ghcr.io/mirantis/hmc/charts-ci" make dev-apply +KUBECONFIG=kubeconfig IMG="ghcr.io/k0rdent/kcm/controller-ci:v0.0.1-179-ga5bdf29" REGISTRY_REPO="oci://ghcr.io/k0rdent/kcm/charts-ci" make dev-apply KUBECONFIG=kubeconfig make dev-templates ``` * The infrastructure will need to manually be marked `Ready` to get the diff --git a/docs/credential/main.md b/docs/credential/main.md index 67a1b05..b68e648 100644 --- a/docs/credential/main.md +++ b/docs/credential/main.md @@ -98,7 +98,7 @@ Since this feature depends on the provider some notes and clarifications are needed for each provider. > NOTE: -> More detailed research notes can be found [here](https://github.com/Mirantis/hmc/issues/293). +> More detailed research notes can be found [here](https://github.com/k0rdent/kcm/issues/293). #### AWS diff --git a/docs/index.md b/docs/index.md index 6e7f4b6..a11a390 100644 --- a/docs/index.md +++ b/docs/index.md @@ -50,4 +50,4 @@ had `ProviderTemplates` created and validated, and more are in the works. ## Development Documentation Documentation related to development process and developer specific notes located in -the [main repository](https://github.com/Mirantis/hmc/blob/main/docs/dev.md). +the [main repository](https://github.com/k0rdent/kcm/blob/main/docs/dev.md). diff --git a/docs/quick-start/2a-installation.md b/docs/quick-start/2a-installation.md index a5dc1f6..3b36cc5 100644 --- a/docs/quick-start/2a-installation.md +++ b/docs/quick-start/2a-installation.md @@ -23,7 +23,7 @@ It may be helpful to have the following tools installed: ## Installation via Helm ```bash -helm install hmc oci://ghcr.io/mirantis/hmc/charts/hmc --version 0.0.4 -n hmc-system --create-namespace +helm install hmc oci://ghcr.io/k0rdent/kcm/charts/hmc --version 0.0.6 -n hmc-system --create-namespace ``` ## Verification diff --git a/docs/template/pre-defined-service-templates.md b/docs/template/pre-defined-service-templates.md index 5c21444..e5ba374 100644 --- a/docs/template/pre-defined-service-templates.md +++ b/docs/template/pre-defined-service-templates.md @@ -4,7 +4,7 @@ HMC comes with a set of pre-defined ServiceTemplates. These templates are referr > NOTE: > Listed Helm charts will be looked up in the registry configured by the `--default-registry-url` -> flag provided to the `hmc-controller-manager` (default value: `oci://ghcr.io/mirantis/hmc/charts`). +> flag provided to the `hmc-controller-manager` (default value: `oci://ghcr.io/k0rdent/kcm/charts`). > In case of using different registry, the corresponding Helm charts must be available > in the registry in prior to using the ServiceTemplate. diff --git a/docs/usage/2a-upgrade.md b/docs/usage/2a-upgrade.md index 53269a8..8a6e9cc 100644 --- a/docs/usage/2a-upgrade.md +++ b/docs/usage/2a-upgrade.md @@ -8,11 +8,11 @@ Follow the steps below to update 2A to a newer version: **Step 1. Create a New `Release` Object** Create a `Release` object in the management cluster for the desired version. For example, to create -a `Release` for version `v0.0.4`, run the following command: +a `Release` for version `v0.0.6`, run the following command: ```shell -VERSION=v0.0.4 -kubectl create -f https://github.com/Mirantis/hmc/releases/download/${VERSION}/release.yaml +VERSION=v0.0.6 +kubectl create -f https://github.com/k0rdent/kcm/releases/download/${VERSION}/release.yaml ``` **Step 2. Update the `Management` Object with the New `Release`** @@ -29,8 +29,8 @@ Example output: ```shell NAME AGE -hmc-0-0-3 71m -hmc-0-0-4 65m +hmc-0-0-5 71m +hmc-0-0-6 65m ``` - Patch the `Management` Object with the New `Release` Name: @@ -39,7 +39,7 @@ Update the `spec.release` field in the `Management` object to point to the new r the name of your new release: ```shell -RELEASE_NAME=hmc-0-0-4 +RELEASE_NAME=hmc-0-0-6 kubectl patch management.hmc hmc --patch "{\"spec\":{\"release\":\"${RELEASE_NAME}\"}}" --type=merge ``` diff --git a/docs/usage/installation.md b/docs/usage/installation.md index 2f24cf1..2b162a9 100644 --- a/docs/usage/installation.md +++ b/docs/usage/installation.md @@ -9,14 +9,14 @@ export KUBECONFIG= ``` ```bash -helm install hmc oci://ghcr.io/mirantis/hmc/charts/hmc --version -n hmc-system --create-namespace +helm install hmc oci://ghcr.io/k0rdent/kcm/charts/hmc --version -n hmc-system --create-namespace ``` This will use the defaults as seen in Extended Management Configuration section below. ## Finding Releases -Releases are tagged in the GitHub repository and can be found [here](https://github.com/Mirantis/hmc/tags). +Releases are tagged in the GitHub repository and can be found [here](https://github.com/k0rdent/kcm/tags). ## Extended Management Configuration @@ -35,10 +35,10 @@ spec: - name: cluster-api-provider-azure - name: cluster-api-provider-vsphere - name: projectsveltos - release: hmc-0-0-3 + release: hmc-0-0-6 ``` To see what is included in a specific release, look at the `release.yaml` file in the tagged release. -For example, here is the [v0.0.3 release.yaml](https://github.com/Mirantis/hmc/releases/download/v0.0.3/release.yaml). +For example, here is the [v0.0.6 release.yaml](https://github.com/k0rdent/kcm/releases/download/v0.0.6/release.yaml). There are two options to override the default management configuration of Project 2A: diff --git a/mkdocs.yml b/mkdocs.yml index 6ff6507..d8da45a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,8 +1,8 @@ -site_name: Project 2A +site_name: K0rdent site_author: Mirantis docs_dir: ./docs repo_name: GitHub -repo_url: https://github.com/mirantis/hmc +repo_url: https://github.com/K0rdent/kcm copyright: '© 2005 - 2024 Mirantis, Inc. All rights reserved.' theme: