Skip to content

Commit

Permalink
Repository rename related changes (#73)
Browse files Browse the repository at this point in the history
  • Loading branch information
a13x5 authored Jan 4, 2025
1 parent 6cbbfe1 commit e1a3af6
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 26 deletions.
20 changes: 11 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/clustertemplates/aws/hosted-control-plane.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/credential/main.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
2 changes: 1 addition & 1 deletion docs/quick-start/2a-installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/template/pre-defined-service-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions docs/usage/2a-upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`**
Expand All @@ -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:
Expand All @@ -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
```

Expand Down
8 changes: 4 additions & 4 deletions docs/usage/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,14 @@ export KUBECONFIG=<path-to-management-kubeconfig>
```

```bash
helm install hmc oci://ghcr.io/mirantis/hmc/charts/hmc --version <hmc-version> -n hmc-system --create-namespace
helm install hmc oci://ghcr.io/k0rdent/kcm/charts/hmc --version <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

Expand All @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down

0 comments on commit e1a3af6

Please sign in to comment.