-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from p5ntangle/main
Updates to basic doc strucuture
- Loading branch information
Showing
8 changed files
with
271 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # Welcome to HMC Docs | ||
| # Welcome to Mirantis Project 2A Docs | ||
|
|
||
|
|
||
| # Introduction | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,214 @@ | ||
| ### Installation | ||
|
|
||
| ``` | ||
| export KUBECONFIG=<path-to-management-kubeconfig> | ||
| helm install hmc oci://ghcr.io/mirantis/hmc/charts/hmc --version <hmc-version> -n hmc-system --create-namespace | ||
| ``` | ||
|
|
||
|
|
||
| #### Extended Management configuration | ||
|
|
||
| By default, the Hybrid Container Cloud is being deployed with the following configuration: | ||
|
|
||
| ```yaml | ||
| apiVersion: hmc.mirantis.com/v1alpha1 | ||
| kind: Management | ||
| metadata: | ||
| name: hmc | ||
| spec: | ||
| core: | ||
| capi: | ||
| template: cluster-api | ||
| hmc: | ||
| template: hmc | ||
| providers: | ||
| - template: k0smotron | ||
| - config: | ||
| configSecret: | ||
| name: aws-variables | ||
| template: cluster-api-provider-aws | ||
| ``` | ||
| There are two options to override the default management configuration of HMC: | ||
| 1. Update the `Management` object after the HMC installation using `kubectl`: | ||
|
|
||
| `kubectl --kubeconfig <path-to-management-kubeconfig> edit management` | ||
|
|
||
| 2. Deploy HMC skipping the default `Management` object creation and provide your own `Management` | ||
| configuration: | ||
|
|
||
| * Create `management.yaml` file and configure core components and providers. | ||
| See [Management API](api/v1alpha1/management_types.go). | ||
|
|
||
| * Specify `--create-management=false` controller argument and install HMC: | ||
|
|
||
| If installing using `helm` add the following parameter to the `helm install` command: | ||
|
|
||
| `--set="controller.createManagement=false"` | ||
|
|
||
| * Create `hmc` `Management` object after HMC installation: | ||
|
|
||
| `kubectl --kubeconfig <path-to-management-kubeconfig> create -f management.yaml` | ||
|
|
||
| ## Deploy a managed cluster | ||
|
|
||
| To deploy a managed cluster: | ||
|
|
||
| 1. Select the `Template` you want to use for the deployment. To list all available templates, run: | ||
|
|
||
| ```bash | ||
| export KUBECONFIG=<path-to-management-kubeconfig> | ||
| kubectl get template -n hmc-system -o go-template='{{ range .items }}{{ if eq .status.type "deployment" }}{{ .metadata.name }}{{ printf "\n" }}{{ end }}{{ end }}' | ||
| ``` | ||
|
|
||
| For details about the `Template system` in HMC, see [Templates system](../templates/main.md). | ||
|
|
||
| If you want to deploy hostded control plate template, make sure to check additional notes on [Hosted control plane](../aws/hosted-control-plane.md). | ||
|
|
||
| 2. Create the file with the `ManagedCluster` configuration: | ||
|
|
||
| > Substitute the parameters enclosed in angle brackets with the corresponding values.\ | ||
| > Enable the `dryRun` flag if required. For details, see [Dry run](#dry-run). | ||
|
|
||
| ```yaml | ||
| apiVersion: hmc.mirantis.com/v1alpha1 | ||
| kind: ManagedCluster | ||
| metadata: | ||
| name: <cluster-name> | ||
| namespace: <cluster-namespace> | ||
| spec: | ||
| template: <template-name> | ||
| dryRun: <true/false> | ||
| config: | ||
| <cluster-configuration> | ||
| ``` | ||
|
|
||
| 3. Create the `ManagedCluster` object: | ||
|
|
||
| `kubectl create -f managedcluster.yaml` | ||
|
|
||
| 4. Check the status of the newly created `ManagedCluster` object: | ||
|
|
||
| `kubectl -n <managedcluster-namespace> get managedcluster <managedcluster-name> -o=yaml` | ||
|
|
||
| 5. Wait for infrastructure to be provisioned and the cluster to be deployed (the provisioning starts only when | ||
| `spec.dryRun` is disabled): | ||
|
|
||
| `kubectl -n <managedcluster-namespace> get cluster <managedcluster-name> -o=yaml` | ||
|
|
||
| > You may also watch the process with the `clusterctl describe` command (requires the `clusterctl` CLI to be installed): | ||
| > ``` | ||
| > clusterctl describe cluster <managedcluster-name> -n <managedcluster-namespace> --show-conditions all | ||
| > ``` | ||
|
|
||
| 6. Retrieve the `kubeconfig` of your managed cluster: | ||
|
|
||
| ``` | ||
| kubectl get secret -n hmc-system <managedcluster-name>-kubeconfig -o=jsonpath={.data.value} | base64 -d > kubeconfig | ||
| ``` | ||
|
|
||
| ### Dry run | ||
|
|
||
| HMC `ManagedCluster` supports two modes: with and without (default) `dryRun`. | ||
|
|
||
| If no configuration (`spec.config`) provided, the `ManagedCluster` object will be populated with defaults | ||
| (default configuration can be found in the corresponding `Template` status) and automatically marked as `dryRun`. | ||
|
|
||
| Here is an example of the `ManagedCluster` object with default configuration: | ||
|
|
||
| ```yaml | ||
| apiVersion: hmc.mirantis.com/v1alpha1 | ||
| kind: ManagedCluster | ||
| metadata: | ||
| name: <cluster-name> | ||
| namespace: <cluster-namespace> | ||
| spec: | ||
| config: | ||
| clusterNetwork: | ||
| pods: | ||
| cidrBlocks: | ||
| - 10.244.0.0/16 | ||
| services: | ||
| cidrBlocks: | ||
| - 10.96.0.0/12 | ||
| controlPlane: | ||
| amiID: "" | ||
| iamInstanceProfile: control-plane.cluster-api-provider-aws.sigs.k8s.io | ||
| instanceType: "" | ||
| controlPlaneNumber: 3 | ||
| k0s: | ||
| version: v1.27.2+k0s.0 | ||
| publicIP: false | ||
| region: "" | ||
| sshKeyName: "" | ||
| worker: | ||
| amiID: "" | ||
| iamInstanceProfile: nodes.cluster-api-provider-aws.sigs.k8s.io | ||
| instanceType: "" | ||
| workersNumber: 2 | ||
| template: aws-standalone-cp | ||
| dryRun: true | ||
| ``` | ||
|
|
||
| After you adjust your configuration and ensure that it passes validation (`TemplateReady` condition | ||
| from `status.conditions`), remove the `spec.dryRun` flag to proceed with the deployment. | ||
|
|
||
| Here is an example of a `ManagedCluster` object that passed the validation: | ||
|
|
||
| ```yaml | ||
| apiVersion: hmc.mirantis.com/v1alpha1 | ||
| kind: ManagedCluster | ||
| metadata: | ||
| name: aws-standalone | ||
| namespace: aws | ||
| spec: | ||
| template: aws-standalone-cp | ||
| config: | ||
| region: us-east-2 | ||
| publicIP: true | ||
| controlPlaneNumber: 1 | ||
| workersNumber: 1 | ||
| controlPlane: | ||
| amiID: ami-02f3416038bdb17fb | ||
| instanceType: t3.small | ||
| worker: | ||
| amiID: ami-02f3416038bdb17fb | ||
| instanceType: t3.small | ||
| status: | ||
| conditions: | ||
| - lastTransitionTime: "2024-07-22T09:25:49Z" | ||
| message: Template is valid | ||
| reason: Succeeded | ||
| status: "True" | ||
| type: TemplateReady | ||
| - lastTransitionTime: "2024-07-22T09:25:49Z" | ||
| message: Helm chart is valid | ||
| reason: Succeeded | ||
| status: "True" | ||
| type: HelmChartReady | ||
| - lastTransitionTime: "2024-07-22T09:25:49Z" | ||
| message: ManagedCluster is ready | ||
| reason: Succeeded | ||
| status: "True" | ||
| type: Ready | ||
| observedGeneration: 1 | ||
| ``` | ||
|
|
||
| ## Cleanup | ||
|
|
||
| 1. Remove the Management object: | ||
|
|
||
| `kubectl delete management.hmc hmc` | ||
|
|
||
| > Note: make sure you have no HMC ManagedCluster objects left in the cluster prior to Management deletion | ||
|
|
||
| 2. Remove the `hmc` Helm release: | ||
|
|
||
| `helm uninstall hmc -n hmc-system` | ||
|
|
||
| 3. Remove the `hmc-system` namespace: | ||
|
|
||
| `kubectl delete ns hmc-system` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # HMC MKdocs Setup | ||
| # Project 2A MKdocs Setup | ||
|
|
||
| ## Project layout | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters