oms

Operations Management System - OMS

This repository contains the source for the operations management system. It contains the sources for both the CLI and the Service.

OMS CLI

The OMS CLI tool is used to bootstrap Codesphere cluster on customer sites and replaces the formerly used private cloud installer.

Installation

You can install the OMS CLI in a few ways:

Using GitHub CLI (gh)

If you have the GitHub CLI installed, you can install the OMS CLI with a command like the following. Note that some commands may require you to elevate to the root user with sudo.

gh release download -R codesphere-cloud/oms -O /usr/local/bin/oms -p "oms*darwin_arm64"
chmod +x /usr/local/bin/oms

gh release download -R codesphere-cloud/oms -O /usr/local/bin/oms -p "oms*linux_amd64"
chmod +x /usr/local/bin/oms

Using wget

This option requires to have the wget and jq utils installed. Download the OMS CLI and add permissions to run it with the following commands: Note that some commands may require you to elevate to the root user with sudo.

wget -qO- 'https://api.github.com/repos/codesphere-cloud/oms/releases/latest' | jq -r '.assets[] | select(.name | match("oms.*darwin_arm64")) | .browser_download_url' | xargs wget -O oms
mv oms /usr/local/bin/oms
chmod +x /usr/local/bin/oms

wget -qO- 'https://api.github.com/repos/codesphere-cloud/oms/releases/latest' | jq -r '.assets[] | select(.name | match("oms.*linux_amd64")) | .browser_download_url' | xargs wget -O oms
mv oms /usr/local/bin/oms
chmod +x /usr/local/bin/oms

Manual Download

You can also download the pre-compiled binaries from the OMS Releases page. Note that some commands may require you to elevate to the root user with sudo.

1. Go to the latest release.

2. Download the appropriate release for your operating system and architecture (e.g., oms_darwin_amd64 for macOS, oms_linux_amd64 for Linux, or oms_windows_amd64 for Windows).

3. Move the oms binary to a directory in your system's PATH (e.g., /usr/local/bin on Linux/Mac, or a directory added to Path environment variable on Windows).

4. Make the binary executable (e.g. by running chmod +x /usr/local/bin/oms on Mac or Linux)

Available Commands

The OMS CLI organizes its functionality into several top-level commands, each with specific subcommands and flags.

See our Usage Documentation for usage information about the specific subcommands.

How to Build?

make build-cli

See also [CONTRIBUTION.md]

Service

The service implementation is currently WIP

How to Build?

make build-service

Community & Contributions

Please review our Code of Conduct to understand our community expectations. We welcome contributions! All contributions to this project must be made in accordance with the Developer Certificate of Origin (DCO). See our full Contributing Guidelines for details.