Skip to content

Commit

Permalink
Add docs related to deployment of beach-head services
Browse files Browse the repository at this point in the history
  • Loading branch information
wahabmk committed Dec 12, 2024
1 parent d18a5ef commit 5f79e78
Show file tree
Hide file tree
Showing 6 changed files with 819 additions and 262 deletions.
6 changes: 5 additions & 1 deletion docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,10 @@ OpenStack, etc.).
### Managed cluster
A Kubernetes cluster created and managed by Project 2A.

### Mutli Cluster Service
The `MultiClusterService` is a custom resource used to manage deployment of beach-head services
across multiple clusters.

### Management cluster
The Kubernetes cluster where 2A is installed and from which all other managed
clusters are managed.
clusters are managed.
102 changes: 76 additions & 26 deletions docs/quick-start/2a-installation.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### Requirements
## Requirements

Project 2A requires a Kubernetes cluster. It can be of any type and will become
the 2A _management cluster_.
Expand All @@ -12,34 +12,34 @@ The following instructions assume:
- You have [Helm](https://helm.sh/docs/intro/install/) installed.
- You have [kubectl](https://kubernetes.io/docs/tasks/tools/) installed.

#### Helpful Tools
### Helpful Tools

It may be helpful to have the following tools installed:

- [clusterctl](https://cluster-api.sigs.k8s.io/user/quick-start.html?highlight=clusterctl#install-clusterctl)
- [Mirantis Lens](https://k8slens.dev/)
- [k9s](https://k9scli.io/)

### Installation via Helm
## Installation via Helm

```bash
helm install hmc oci://ghcr.io/mirantis/hmc/charts/hmc --version 0.0.3 -n hmc-system --create-namespace
helm install hmc oci://ghcr.io/mirantis/hmc/charts/hmc --version 0.0.4 -n hmc-system --create-namespace
```

### Verification
## Verification

The installation takes a couple of minutes until 2A and its subcomponents are
The installation takes a few minutes until 2A and its subcomponents are
fully installed and configured.

Verify the installation by checking all the pods in the `hmc-system` namespace
with the following command:
### Verify Core Components are running

Check pods are running in the `hmc-system` namespace with the following command:

```bash
kubectl get pods -n hmc-system
```

The output is similar to:

The output should be similar to:
```bash
NAME READY STATUS
azureserviceoperator-controller-manager-86d566cdbc-rqkt9 1/1 Running
Expand All @@ -59,33 +59,83 @@ k0smotron-controller-manager-infrastructure-7f77f55675-tv8vb 2/2 Running
source-controller-5f648d6f5d-7mhz5 1/1 Running
```

Checking pods are running in the `projectsveltos` namespace with the following command:
```sh
kubectl get pods -n projectsveltos
```

The output should be similar to:
```sh
NAME READY STATUS RESTARTS AGE
access-manager-cd49cffc9-c4q97 1/1 Running 0 16m
addon-controller-64c7f69796-whw25 1/1 Running 0 16m
classifier-manager-574c9d794d-j8852 1/1 Running 0 16m
conversion-webhook-5d78b6c648-p6pxd 1/1 Running 0 16m
event-manager-6df545b4d7-mbjh5 1/1 Running 0 16m
hc-manager-7b749c57d-5phkb 1/1 Running 0 16m
sc-manager-f5797c4f8-ptmvh 1/1 Running 0 16m
shard-controller-767975966-v5qqn 1/1 Running 0 16m
sveltos-agent-manager-56bbf5fb94-9lskd 1/1 Running 0 15m
```

If you have fewer pods, give 2A more time to reconcile all the pods.

As a second verification, check that the example `ClusterTemplate` objects have
been installed and are valid:
### Verify 2A templates have been successfully reconciled

For additional verification, check that the example templates packaged with 2A have
been installed and are valid.

Check `ProviderTemplate` objects with:

```sh
kubectl get providertemplate -n hmc-system
```

The output should be similar to:

```sh
NAME VALID
cluster-api-0-0-3 true
cluster-api-provider-aws-0-0-3 true
cluster-api-provider-azure-0-0-3 true
cluster-api-provider-vsphere-0-0-3 true
hmc-0-0-4 true
k0smotron-0-0-3 true
projectsveltos-0-42-0 true
```

Check `ClusterTemplate` objects with:

```bash
kubectl get clustertemplate -n hmc-system
```

The output is similar to:
The output should be similar to:

```bash
NAME VALID
aws-eks-0-0-1 true
aws-hosted-cp-0-0-2 true
aws-standalone-cp-0-0-1 true
aws-standalone-cp-0-1-0 true
aws-eks-0-0-2 true
aws-hosted-cp-0-0-3 true
aws-standalone-cp-0-0-3 true
azure-hosted-cp-0-0-3 true
azure-standalone-cp-0-0-1 true
azure-standalone-cp-0-1-0 true
remote-single-standalone-cp-0-1-4 true
remote-single-standalone-cp-0-1-5 true
remote-single-standalone-cp-0-1-6 true
remote-single-standalone-cp-0-1-7 true
remote-single-standalone-cp-0-1-8 true
vsphere-hosted-cp-0-0-2 true
vsphere-standalone-cp-0-0-2 true
azure-standalone-cp-0-0-3 true
vsphere-hosted-cp-0-0-3 true
vsphere-standalone-cp-0-0-3 true
```

Check `ServiceTemplate` objects with:

```sh
kubectl get servicetemplate -n hmc-system
```

The output should be similar to:

```sh
NAME VALID
ingress-nginx-4-11-0 true
ingress-nginx-4-11-3 true
kyverno-3-2-6 true
```

### Next Step
Expand Down
232 changes: 0 additions & 232 deletions docs/smc/servicetemplate_usage_guide.md

This file was deleted.

Loading

0 comments on commit 5f79e78

Please sign in to comment.