chore: First Update README.md and add oc-deploy component documentation
This commit is contained in:
parent
00d92b73f8
commit
333dfce355
66
README.md
66
README.md
@ -35,5 +35,69 @@ Install Talos
|
|||||||
chmod 700 get_helm.sh
|
chmod 700 get_helm.sh
|
||||||
./get_helm.sh
|
./get_helm.sh
|
||||||
|
|
||||||
|
--------------------------
|
||||||
# Create OpenCloud Chart
|
# Create OpenCloud Chart
|
||||||
helm create occhart
|
|
||||||
|
# `oc-deploy` Component
|
||||||
|
|
||||||
|
The `oc-deploy` component aims to simplify and automate the deployment of OpenCloud components on a Kubernetes cluster through the creation of Helm Charts.
|
||||||
|
|
||||||
|
## Prerequisites:
|
||||||
|
- Access to the OpenCloud forge and the associated Harbor registry: [https://registry.o-forge.io/](https://registry.o-forge.io/), which will allow pulling OpenCloud release images from the "stable" project.
|
||||||
|
- To test the connection to this registry from the Docker client:
|
||||||
|
```bash
|
||||||
|
docker login registry.o-forge.io
|
||||||
|
```
|
||||||
|
- A Kubernetes cluster: Minikube, K3s, RKE2, etc. See `KubernetesCluster`.
|
||||||
|
- Helm installed locally
|
||||||
|
|
||||||
|
## **To Be Defined:**
|
||||||
|
### Configuring a Docker Secret for Kubernetes
|
||||||
|
Kubernetes needs to know your credentials to pull images from the "registry.o-forge.io" registry. Create a Docker secret in Kubernetes:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
kubectl create secret docker-registry regcred \
|
||||||
|
--docker-server=registry.o-forge.io \
|
||||||
|
--docker-username=<your_username> \
|
||||||
|
--docker-password=<your_password> \
|
||||||
|
--docker-email=<your_email>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Checking if Helm Recognizes Your Local Kubernetes Cluster:
|
||||||
|
|
||||||
|
### 1. Verify Connection to Kubernetes:
|
||||||
|
Before checking Helm, ensure that your `kubectl` is properly configured to connect to your local Kubernetes cluster.
|
||||||
|
Run the following command to see if you can communicate with the cluster:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
kubectl get nodes
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
If this command returns the list of nodes in your cluster, it means `kubectl` is properly connected.
|
||||||
|
|
||||||
|
### 2. Verify Helm Configuration:
|
||||||
|
Now, you can check if Helm can access the cluster by using the following command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
helm version
|
||||||
|
```
|
||||||
|
|
||||||
|
This command displays the Helm version and the Kubernetes version it is connected to.
|
||||||
|
|
||||||
|
## Deploying with Helm:
|
||||||
|
You can deploy the `oc-deploy` Chart with Helm:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
helm install oc-deploy path/to/your/Helm/oc-deploy
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
## Checking Helm Releases:
|
||||||
|
You can also list the existing releases to see if Helm is properly connected to the cluster:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
helm list
|
||||||
|
```
|
||||||
|
|
||||||
|
If all these commands execute without errors and give the expected results, your Helm installation is correctly configured to recognize and interact with your local Kubernetes cluster
|
Loading…
Reference in New Issue
Block a user