https://github.com/cloudforet-io/launchpad
Cloudforet launchpad
https://github.com/cloudforet-io/launchpad
aws docker golang installer kubernetes tools
Last synced: about 1 year ago
JSON representation
Cloudforet launchpad
- Host: GitHub
- URL: https://github.com/cloudforet-io/launchpad
- Owner: cloudforet-io
- License: apache-2.0
- Created: 2022-09-05T01:09:56.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-28T05:13:14.000Z (about 2 years ago)
- Last Synced: 2024-04-28T07:36:27.094Z (about 2 years ago)
- Topics: aws, docker, golang, installer, kubernetes, tools
- Language: Smarty
- Homepage:
- Size: 27.7 MB
- Stars: 6
- Watchers: 4
- Forks: 4
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://github.com/kubernetes-sigs/aws-load-balancer-controller)
- [External DNS](https://github.com/kubernetes-sigs/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](https://github.com/kubernetes-sigs/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](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types).
To expose Cloudforet, you should the ingress resource.
- [Install ingress controller](https://kubernetes.io/docs/concepts/services-networking/ingress-controllers/)
- 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.
```diff
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](https://cloudforet.io/docs/guides/getting-started/)
- [Youtube video](https://youtu.be/zSoEg2v_JrE)
## 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](https://github.com/cloudforet-io/charts), 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