Cloudforet launchpad

The Cloudforet launchpad is a command line interface that allows you to easily install Cloudforet.

Install standard configuration

Cloudforet is a cloud-native based application.
As a result, the following resources are created.

• Certificate managed by ACM
• VPC & EKS
• DocumentDB
• Secret manager
• Kubernetes controllers
  • AWS Load Balancer Controller
  • External DNS
• Cloudforet
  • root domain
  • user domain

Prerequisite

• Docker
• Public domain managed by Route53 (standard only)

1. git clone

git clone https://github.com/cloudforet-io/launchpad.git

2. set aws credential file

vim {repo}/vars/aws_credential.yaml

aws:
  aws_access_key_id : aws_access_key_id
  aws_secret_access_key : aws_secret_access_key
  region : default_region

3. Setting up the configuration file

• {repo}/vars/certificate.conf # for certificate
• {repo}/vars/eks.conf # for eks
• {repo}/vars/documentdb.conf # for document db
• {repo}/vars/deployment.conf # for Cloudforet helm chart
• {repo}/vars/initialization.conf # for initialize Cloudforet domain

4. Execute script

Execute launchpad script.(It takes about 3~40 minutes to complete.)

./launchpad.sh install

Install minimal set

Also, Cloudforet can be installed as a minimal set.
It only provides Cloudforet applications and alb ingress, other components are deployed as pods.

minimal set creates the following resources.

• VPC & EKS
• Kubernetes controllers
  • AWS Load Balancer Controller
• SpaceONE
  • root domain
  • user domain

Prerequisite

• Docker

1. git clone

git clone https://github.com/spaceone-dev/launchpad.git

2. set aws credential file

vim {repo}/vars/aws_credential.yaml

aws:
  aws_access_key_id : aws_access_key_id
  aws_secret_access_key : aws_secret_access_key
  region : default_region

3. Setting up the configuration file

• {repo}/vars/eks.conf # for eks
• {repo}/vars/deployment.conf # for Cloudforet helm chart
• {repo}/vars/initialization.conf # for initialize Cloudforet domain

  4. Execute script

  Execute launchpad script.(It takes about 3~40 minutes to complete.)
  

  ./launchpad.sh install --minimal

Install Cloudforet application only (deploy)

If you already have a kubernetes cluster, only Cloudforet applications can be deployed.

NOTE

It does not provide ingress resources and uses service of nodePort type.
To expose Cloudforet, you should the ingress resource.

• Install ingress controller
• Update Cloudforet values(refer to Management section of this document)
  

Prerequisite

• Docker

1. set kubectl config

cp /your/kubectl/config {repo}/data/kubeconfig/config

2. Setting up the configuration file

• {repo}/vars/deployment.conf # for SpaceONE helm chart
• {repo}/vars/initialization.conf # for initialize SpaceONE domain

3. Execute script

./launchpad.sh deploy

Login to Cloudforet

standard

Open a browser(http://spaceone.console.your-domain.com) and log in to the root account with the information below.

• ID : domain_owner in initialization.conf
• PASSWORD : domain_owner_password in initialization.conf

minimal

After the installation is complete, the domain record must be added to /etc/hosts on the local PC.
Domain records will be displayed after installation is completed.

vim /etc/hosts
---
.
.
.
+xxx.xxx.xxx.xxx spaceone.console-dev.com

And Open a browser(http://spaceone.console-dev.com), log in to the root account with the information below.

• ID : domain_owner in initialization.conf
• PASSWORD : domain_owner_password in initialization.conf

deploy

After the installation is complete, the access point will be displayed.

Open a browser(http://Node_IP:Port)log in to the root account with the information below.

• ID : domain_owner in initialization.conf

• PASSWORD : domain_owner_password in initialization.conf

  SpaceONE Basic Setup

  For basic setup, please refer to the user guide or watch the YouTube video.

• SpaceONE User Guide

• Youtube video

Management

Upgrade Cloudforet

To change Cloudforet configuration, Update helm value files and run upgrade command.

• Update value files

  ## standard version
  vim {repo}/data/helm/values/spaceone/{value|frontend|database}.yaml

  ## minimal version
  vim {repo}/data/helm/values/spaceone/minimal.yaml

• Upgrade helm chart
  • If there is a new helm chart, use the --update-repo option.

    ./launchpad.sh upgrade {--update-repo}

Destroy Cloudforet

./launchpad.sh destroy

Cloudforet discuss channel

https://github.com/cloudforet-io/community/discussions

Cloudforet release example

https://github.com/cloudforet-io/charts