{"id":13509499,"url":"https://github.com/caos/orbos","last_synced_at":"2025-03-30T13:32:23.012Z","repository":{"id":36977711,"uuid":"224821033","full_name":"caos/orbos","owner":"caos","description":"ORBOS - GitOps everything","archived":true,"fork":false,"pushed_at":"2023-03-07T00:38:28.000Z","size":83717,"stargazers_count":115,"open_issues_count":107,"forks_count":9,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-02T02:14:05.412Z","etag":null,"topics":["baremetal","cloud","cluster","gitops","google-cloud","infrastructure","kubernetes","operator","paas","platform","reconciler"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/caos.png","metadata":{"files":{"readme":"README.md","changelog":"changelog.config.js","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-29T09:27:18.000Z","updated_at":"2024-05-06T09:31:39.000Z","dependencies_parsed_at":"2024-06-18T20:10:53.410Z","dependency_job_id":null,"html_url":"https://github.com/caos/orbos","commit_stats":null,"previous_names":["caos/orbiter"],"tags_count":735,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caos%2Forbos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caos%2Forbos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caos%2Forbos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/caos%2Forbos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/caos","download_url":"https://codeload.github.com/caos/orbos/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222552879,"owners_count":17002160,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["baremetal","cloud","cluster","gitops","google-cloud","infrastructure","kubernetes","operator","paas","platform","reconciler"],"created_at":"2024-08-01T02:01:08.642Z","updated_at":"2024-11-01T09:31:34.404Z","avatar_url":"https://github.com/caos.png","language":"Go","funding_links":[],"categories":["Go","kubernetes"],"sub_categories":[],"readme":":warning: ORBOS is in maintenance mode and not actively developed anymore. Generally, important fixes are done and pull requests are reviewed and merged.\n\n\n# ORBOS - GitOps everything\n\n![ORBOS](./docs/img/orbos-logo-oneline-lightdesign@2x.png)\n\n[![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)\n[![Release](https://github.com/caos/orbos/workflows/Release/badge.svg)](https://github.com/caos/orbos/actions)\n[![license](https://badgen.net/github/license/caos/orbos/)](https://github.com/caos/orbos/blob/master/LICENSE)\n[![release](https://badgen.net/github/release/caos/orbos/stable)](https://github.com/caos/orbos/releases)\n[![Go Report Card](https://goreportcard.com/badge/github.com/caos/orbos)](https://goreportcard.com/report/github.com/caos/orbos)\n[![codecov](https://codecov.io/gh/caos/orbos/branch/master/graph/badge.svg)](https://codecov.io/gh/caos/orbos)\n\n## [ORBOS explained](docs/explained.md)\n\n### [ORBITER](docs/orbiter/orbiter.md)\n\n### [BOOM](docs/boom/boom.md)\n\n## Getting Started on Google Compute Engine\n\nIn 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.\n\n### Initialize A Git Repository\n\nCopy the files [orbiter.yml](examples/orbiter/gce/orbiter.yml) and [boom.yml](examples/boom/boom.yml) to the root of a new git Repository.\n\n### Configure your local environment\n\n```bash\n# Install the latest orbctl\ncurl -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\nsudo chmod +x /usr/local/bin/orbctl\nsudo chown $(id -u):$(id -g) /usr/local/bin/orbctl\n\n# Create an orb file at ${HOME}/.orb/config\nMY_GIT_REPO=\"git@github.com:me/my-orb.git\"\norbctl --gitops configure --repourl ${MY_GIT_REPO} --masterkey \"$(openssl rand -base64 21)\"\n```\n\n### Configure a billable Google Cloud Platform project of your choice\n\n```bash\nMY_GCE_PROJECT=\"$(gcloud config get-value project)\"\nORBOS_SERVICE_ACCOUNT_NAME=orbiter-system\nORBOS_SERVICE_ACCOUNT=${ORBOS_SERVICE_ACCOUNT_NAME}@${MY_GCE_PROJECT}.iam.gserviceaccount.com\n\n# Create a service account for the ORBITER user\ngcloud iam service-accounts create ${ORBOS_SERVICE_ACCOUNT_NAME} \\\n    --description=\"${ORBOS_SERVICE_ACCOUNT_NAME}\" \\\n    --display-name=\"${ORBOS_SERVICE_ACCOUNT_NAME}\"\n\n# Assign the service account the roles `Compute Admin`, `IAP-secured Tunnel User` and `Service Usage Admin`\ngcloud projects add-iam-policy-binding ${MY_GCE_PROJECT} \\\n    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \\\n    --role=roles/compute.admin\ngcloud projects add-iam-policy-binding ${MY_GCE_PROJECT} \\\n    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \\\n    --role=roles/iap.tunnelResourceAccessor\ngcloud projects add-iam-policy-binding ${MY_GCE_PROJECT} \\\n    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \\\n    --role=roles/serviceusage.serviceUsageAdmin\ngcloud projects add-iam-policy-binding ${MY_GCE_PROJECT} \\\n    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \\\n    --role=roles/iam.serviceAccountUser\n\n\n# Create a JSON key for the service account\ngcloud iam service-accounts keys create /tmp/key.json \\\n  --iam-account ${ORBOS_SERVICE_ACCOUNT}\n\n# Encrypt and write the created JSON key to the orbiter.yml\norbctl --gitops writesecret orbiter.gce.jsonkey --file /tmp/key.json\nrm -f /tmp/key.json\n```\n\n### Bootstrap your Kubernetes cluster on GCE\n\n```bash\norbctl --gitops takeoff\n```\n\nAs soon as the Orbiter has deployed itself to the cluster, you can decrypt the generated admin kubeconfig\n\n```bash\nmkdir -p ~/.kube\norbctl --gitops readsecret orbiter.k8s.kubeconfig \u003e ~/.kube/config\n```\n\nWait for grafana to become running\n\n```bash\nkubectl --namespace caos-system get po -w\n```\n\nOpen your browser at `http://localhost:8080` to show your new clusters dashboards. Default username and password are both `admin`\n\n```bash\nkubectl --namespace caos-system port-forward svc/grafana 8080:80\n```\n\nDelete everything created by Orbiter\n\n```bash\n# Remove all GCE compute resources\norbctl --gitops destroy\n\n# Unassign all service account roles\ngcloud projects remove-iam-policy-binding ${MY_GCE_PROJECT} \\\n    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \\\n    --role=roles/compute.admin\ngcloud projects remove-iam-policy-binding ${MY_GCE_PROJECT} \\\n    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \\\n    --role=roles/iap.tunnelResourceAccessor\ngcloud projects remove-iam-policy-binding ${MY_GCE_PROJECT} \\\n    --member=serviceAccount:${ORBOS_SERVICE_ACCOUNT} \\\n    --role=roles/serviceusage.serviceUsageAdmin\n\n# Remove service account\ngcloud iam service-accounts delete --quiet ${ORBOS_SERVICE_ACCOUNT}\n```\n\n## Offerings\n\nThe 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 orbos@caos.ch.\n\n### Support\n\nYou 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.\n\n### Dedicated Orbs\n\nWe 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.\n\n## Usage Data\n\nORBOS 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.\n\nWe 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.\n\nBesides 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 \"\u003ccomponent\u003e invoked\" event along with the flags that are passed to it, except secret values of course.\n## License\n\nThe 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.\n\nSee the exact licensing terms [here](./LICENSE)\n\nUnless 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaos%2Forbos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcaos%2Forbos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcaos%2Forbos/lists"}