Quick Install Guide
This is Quick Installation guide with minikube. This Guide is not for production, but for developer only.
Prerequisites
- AWS EC2 VM
- Kubernetes 1.21+ (minikube, https://minikube.sigs.k8s.io/docs/start/)
- Helm 3.2.0+ (https://helm.sh/docs/intro/install/)
Prepare public EIP for web access.
minikube start --driver=docker --memory=4096mb
Cloudforet Architecture
Docker Images
You can download the docker images from Docker Hub.
| Image Name | Version | Required |
|---|---|---|
| spaceone/console | 1.11.0.27 | O |
| spaceone/console-api | 1.11.0.4 | O |
| spaceone/identity | 1.11.0 | O |
| spaceone/secret | 1.11.0 | O |
| spaceone/repository | 1.11.0.2 | O |
| spaceone/plugin | 1.11.0 | O |
| spaceone/config | 1.11.0 | O |
| spaceone/inventory | 1.11.0.3 | O |
| spaceone/monitoring | 1.11.0.3 | O |
| spaceone/statistics | 1.11.0 | O |
| spaceone/cost-analysis | 1.11.0.3 | O |
| spaceone/notification | 1.11.0 | O |
| spaceone/board | 1.11.0 | O |
| spaceone/file-manager | 1.11.0 | O |
| spaceone/dashboard | 1.11.0.4 | O |
| spaceone/console-api-v2 | 1.11.0.2 | O |
| spaceone/supervisor | 1.11.0.4 | O |
| spaceone/spacectl | 1.11.0.12 | O |
| spaceone/marketplace-assets | 1.11.0.1 | X |
| spaceone/docs | 0.1.20230502.153847 | X |
| mongo | latest | X |
| redis | latest | X |
If your Kubernetes cluster can't access the internet, you need to download the docker images and push them to your private docker registry.
Installation
You can install the Cloudforet using the following the steps.
1) Add Helm Repository
helm repo add cloudforet https://cloudforet-io.github.io/charts
helm repo update
helm search repo
2) Create Namespaces
kubectl create ns spaceone
kubectl create ns spaceone-plugin
If you want to use only one namespace, you don't create the spaceone-plugin namespace.
3) Create Role and RoleBinding
First, download the rbac.yaml file.
wget https://raw.githubusercontent.com/cloudforet-io/charts/master/examples/rbac.yaml -O rbac.yaml
And execute the following command.
kubectl apply -f rbac.yaml -n spaceone-plugin
4) Install Cloudforet Chart
helm install cloudforet cloudforet/spaceone -n spaceone
After executing the above command, check the status of the pod.
kubectl get pod -n spaceone
NAME READY STATUS RESTARTS AGE
board-5746fd9657-vtd45 1/1 Running 0 57s
config-5d4c4b7f58-z8k9q 1/1 Running 0 58s
console-6b64cf66cb-q8v54 1/1 Running 0 59s
console-api-7c95848cb8-sgt56 2/2 Running 0 58s
console-api-v2-rest-7d64bc85dd-987zn 2/2 Running 0 56s
cost-analysis-7b9d64b944-xw9qg 1/1 Running 0 59s
cost-analysis-scheduler-ff8cc758d-lfx4n 0/1 Error 3 (37s ago) 55s
cost-analysis-worker-559b4799b9-fxmxj 1/1 Running 0 58s
cost-analysis-worker-559b4799b9-nf5vs 1/1 Running 0 58s
cost-analysis-worker-559b4799b9-swzw8 1/1 Running 0 58s
cost-analysis-worker-559b4799b9-x8f4j 1/1 Running 0 58s
dashboard-b4cc996-mgwj9 1/1 Running 0 56s
docs-5fb4cc56c7-68qbk 1/1 Running 0 59s
identity-6fc984459d-zk8r9 1/1 Running 0 56s
inventory-67498999d6-722bw 1/1 Running 0 57s
inventory-scheduler-5dc6856d44-4spvm 0/1 CrashLoopBackOff 3 (18s ago) 59s
inventory-worker-68d9fcf5fb-x6knb 1/1 Running 0 55s
marketplace-assets-8675d44557-ssm92 1/1 Running 0 59s
mongodb-7c9794854-cdmwj 1/1 Running 0 59s
monitoring-fdd44bdbf-pcgln 1/1 Running 0 59s
notification-5b477f6c49-gzfl8 1/1 Running 0 59s
notification-scheduler-675696467-gn24j 1/1 Running 0 59s
notification-worker-d88bb6df6-pjtmn 1/1 Running 0 57s
plugin-556f7bc49b-qmwln 1/1 Running 0 57s
plugin-scheduler-86c4c56d84-cmrmn 0/1 CrashLoopBackOff 3 (13s ago) 59s
plugin-worker-57986dfdd6-v9vqg 1/1 Running 0 58s
redis-75df77f7d4-lwvvw 1/1 Running 0 59s
repository-5f5b7b5cdc-lnjkl 1/1 Running 0 57s
secret-77ffdf8c9d-48k46 1/1 Running 0 55s
spacectl-5664788d5d-dtwpr 1/1 Running 0 59s
statistics-67b77b6654-p9wcb 1/1 Running 0 56s
statistics-scheduler-586875947c-8zfqg 0/1 Error 3 (30s ago) 56s
statistics-worker-68d646fc7-knbdr 1/1 Running 0 58s
supervisor-scheduler-6744657cb6-tpf78 2/2 Running 0 59s
Scheduler pods are in
CrashLoopBackOfforErrorstate. This is because the setup is not complete.
5) Initialize the Configuration
First, download the initializer.yaml file.
wget https://raw.githubusercontent.com/cloudforet-io/charts/master/examples/initializer.yaml -O initializer.yaml
And execute the following command.
helm install initializer cloudforet/spaceone-initializer -n spaceone -f initializer.yaml
For more information about the initializer, please refer the spaceone-initializer.
6) Set the Helm Values and Upgrade the Chart
Complete the initialization, you can get the system token from the initializer pod logs.
kubectl logs initializer-5f5b7b5cdc-lnjkl -n spaceone
...
TASK [Print Admin API Key] *********************************************************************************************
"{TOKEN}"
FINISHED [ ok=23, skipped=0 ] ******************************************************************************************
FINISH SPACEONE INITIALIZE
Create the values.yaml file and edit the values. There are three items for update.
- {Change Your EIP}
- {TOKEN}
console:
production_json:
# If you don't have a service domain, you refer to the following 'No Domain & IP Access' example.
CONSOLE_API:
ENDPOINT: http://{Change Your EIP}:8081
CONSOLE_API_V2:
ENDPOINT: http://{Change Your EIP}:8082
DOMAIN_NAME: spaceone
DOMAIN_NAME_REF: spaceone
cost-analysis:
enabled: false
supervisor:
enabled: true
application_scheduler:
NAME: root
HOSTNAME: spaceone-plugin.svc.cluster.local
BACKEND: KubernetesConnector
CONNECTORS:
RepositoryConnector:
endpoint:
v1: grpc://repository:50051
PluginConnector:
endpoint:
v1: grpc://plugin:50051
KubernetesConnector:
namespace: spaceone-plugin
start_port: 50051
end_port: 50052
headless: true
replica:
inventory.Collector: 1
monitoring.DataSource: 1
global:
shared_conf:
TOKEN: '{TOKEN}' # Change the system token
After editing the values.yaml file, upgrade the helm chart.
helm upgrade cloudforet cloudforet/spaceone -n spaceone -f values.yaml
kubectl delete po -n spaceone -l app.kubernetes.io/instance=cloudforet
7) Check the status of the pods
kubectl get pod -n spaceone
If all pods are in Running state, the setup is complete.
Port-forwarding
Installing Cloudforet on minikube doesn't provide any Ingress objects such as Amazon ALB or NGINX ingress controller. We can use kubectl port-forward instead.
# CLI commands
kubectl port-forward -n spaceone svc/console 8080:80 --address='0.0.0.0' &
kubectl port-forward -n spaceone svc/console-api 8081:80 --address='0.0.0.0' &
kubectl port-forward -n spaceone svc/console-api-v2 8082:80 --address='0.0.0.0' &
Start Cloudforet
Log-In (Sign in for Root Account)
Open browser (http://{Your EIP}:8080)
| ID | PASSWORD |
|---|---|
| admin | Admin123!@# |
