Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/caos/orbos

ORBOS - GitOps everything
https://github.com/caos/orbos

baremetal cloud cluster gitops google-cloud infrastructure kubernetes operator paas platform reconciler

Last synced: about 2 months ago
JSON representation

ORBOS - GitOps everything

Awesome Lists containing this project

README 

        
:warning: ORBOS is in maintenance mode and not actively developed anymore. Generally, important fixes are done and pull requests are reviewed and merged.



# ORBOS - GitOps everything



![ORBOS](./docs/img/[email protected])



[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Release](https://github.com/caos/orbos/workflows/Release/badge.svg)](https://github.com/caos/orbos/actions)

[![license](https://badgen.net/github/license/caos/orbos/)](https://github.com/caos/orbos/blob/master/LICENSE)

[![release](https://badgen.net/github/release/caos/orbos/stable)](https://github.com/caos/orbos/releases)

[![Go Report Card](https://goreportcard.com/badge/github.com/caos/orbos)](https://goreportcard.com/report/github.com/caos/orbos)

[![codecov](https://codecov.io/gh/caos/orbos/branch/master/graph/badge.svg)](https://codecov.io/gh/caos/orbos)



## [ORBOS explained](docs/explained.md)



### [ORBITER](docs/orbiter/orbiter.md)



### [BOOM](docs/boom/boom.md)



## Getting Started on Google Compute Engine



In the following example we will create a `kubernetes` cluster on a `GCEProvider`. All the `GCEProvider` needs besides a writable Git Repository is a billable Google Cloud Project and a Google Service Account with sufficient permissions.



### Initialize A Git Repository



Copy the files [orbiter.yml](examples/orbiter/gce/orbiter.yml) and [boom.yml](examples/boom/boom.yml) to the root of a new git Repository.



### Configure your local environment



```bash

# Install the latest orbctl

curl -s https://api.github.com/repos/caos/orbos/releases/latest | grep "browser_download_url.*orbctl-$(uname)-$(uname -m)" | cut -d '"' -f 4 | sudo wget -i - -O /usr/local/bin/orbctl

sudo chmod +x /usr/local/bin/orbctl

sudo chown $(id -u):$(id -g) /usr/local/bin/orbctl



# Create an orb file at ${HOME}/.orb/config

MY_GIT_REPO="[email protected]:me/my-orb.git"

orbctl --gitops configure --repourl ${MY_GIT_REPO} --masterkey "$(openssl rand -base64 21)"

```



### Configure a billable Google Cloud Platform project of your choice



```bash

MY_GCE_PROJECT="$(gcloud config get-value project)"

ORBOS_SERVICE_ACCOUNT_NAME=orbiter-system

ORBOS_SERVICE_ACCOUNT=${ORBOS_SERVICE_ACCOUNT_NAME}@${MY_GCE_PROJECT}.iam.gserviceaccount.com



# Create a service account for the ORBITER user

gcloud iam service-accounts create ${ORBOS_SERVICE_ACCOUNT_NAME} \

    --description="${ORBOS_SERVICE_ACCOUNT_NAME}" \

    --display-name="${ORBOS_SERVICE_ACCOUNT_NAME}"



# Assign the service account the roles `Compute Admin`, `IAP-secured Tunnel User` and `Service Usage Admin`

gcloud projects add-iam-policy-binding ${MY_GCE_PROJECT} \

    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \

    --role=roles/compute.admin

gcloud projects add-iam-policy-binding ${MY_GCE_PROJECT} \

    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \

    --role=roles/iap.tunnelResourceAccessor

gcloud projects add-iam-policy-binding ${MY_GCE_PROJECT} \

    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \

    --role=roles/serviceusage.serviceUsageAdmin

gcloud projects add-iam-policy-binding ${MY_GCE_PROJECT} \

    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \

    --role=roles/iam.serviceAccountUser



# Create a JSON key for the service account

gcloud iam service-accounts keys create /tmp/key.json \

  --iam-account ${ORBOS_SERVICE_ACCOUNT}



# Encrypt and write the created JSON key to the orbiter.yml

orbctl --gitops writesecret orbiter.gce.jsonkey --file /tmp/key.json

rm -f /tmp/key.json

```



### Bootstrap your Kubernetes cluster on GCE



```bash

orbctl --gitops takeoff

```



As soon as the Orbiter has deployed itself to the cluster, you can decrypt the generated admin kubeconfig



```bash

mkdir -p ~/.kube

orbctl --gitops readsecret orbiter.k8s.kubeconfig > ~/.kube/config

```



Wait for grafana to become running



```bash

kubectl --namespace caos-system get po -w

```



Open your browser at `http://localhost:8080` to show your new clusters dashboards. Default username and password are both `admin`



```bash

kubectl --namespace caos-system port-forward svc/grafana 8080:80

```



Delete everything created by Orbiter



```bash

# Remove all GCE compute resources

orbctl --gitops destroy



# Unassign all service account roles

gcloud projects remove-iam-policy-binding ${MY_GCE_PROJECT} \

    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \

    --role=roles/compute.admin

gcloud projects remove-iam-policy-binding ${MY_GCE_PROJECT} \

    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \

    --role=roles/iap.tunnelResourceAccessor

gcloud projects remove-iam-policy-binding ${MY_GCE_PROJECT} \

    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \

    --role=roles/serviceusage.serviceUsageAdmin



# Remove service account

gcloud iam service-accounts delete --quiet ${ORBOS_SERVICE_ACCOUNT}

```



## Offerings



The usage of our open source code is and stays completely free. Below you will find our base offerings without Service Level. If you'd like to operate ORBOS in production we recommend you to get in touch with us to arrange a Service Level Agreement and benefit from guaranteed availability and response times. For further information or if you need something else, contact us now at [email protected].



### Support



You run an maintain your Orbs yourself. Your incidents are treated with a high priority. In return, we charge you with a price from CHF 250 per Orb and Month, decreasing to CHF 100.



### Dedicated Orbs



We run and maintain your Orbs on a supported provider of your choice. Your incidents are treated with a high priority. In return, we charge you with a price from CHF 500 per Orb and Month, decreasing to CHF 100.



## Usage Data



ORBOS components send errors and usage data to CAOS Ltd., so that we are able to identify code improvement potential. If you don't want to send this data or don't have an internet connection, pass the global flag `--disable-analytics` when using orbctl. For disabling ingestion for already-running components, execute the takeoff command again with the `--disable-analytics` flag.



We try to distinguishing the environments from which events come from. As environment identifier, we defer the environment identifier from your git repository URL if the --gitops flag is passed.



Besides from errors that don't clearly come from misconfiguration or cli misuage, we send an inital event when any binary is started. This is a " invoked" event along with the flags that are passed to it, except secret values of course.

## License



The full functionality of the operator is and stays open source and free to use for everyone. We pay our wages by using ORBOS for selling further workload enterprise services like support, monitoring and forecasting, IAM, CI/CD, secrets management etc. Visit our [website](https://caos.ch) and get in touch.



See the exact licensing terms [here](./LICENSE)



Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.