From f1e9c31b66e82f911915cda60dd019215130c07c Mon Sep 17 00:00:00 2001 From: Manuel Dewald Date: Mon, 23 Feb 2026 12:36:34 +0100 Subject: [PATCH 1/3] don't log infra env on failure --- cli/cmd/bootstrap_gcp.go | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) diff --git a/cli/cmd/bootstrap_gcp.go b/cli/cmd/bootstrap_gcp.go index 3770c79e..482dd232 100644 --- a/cli/cmd/bootstrap_gcp.go +++ b/cli/cmd/bootstrap_gcp.go @@ -122,33 +122,30 @@ func (c *BootstrapGcpCmd) BootstrapGcp() error { } err = bs.Bootstrap() - envBytes, err2 := json.MarshalIndent(bs.Env, "", " ") + envBytes, errMarshal := json.MarshalIndent(bs.Env, "", " ") - envString := string(envBytes) - if err2 != nil { - envString = "" + if errMarshal == nil { + workdir := env.NewEnv().GetOmsWorkdir() + err = fw.MkdirAll(workdir, 0755) + if err != nil { + log.Printf("warning: failed to create workdir: %v", err) + } + infraFilePath := gcp.GetInfraFilePath() + err = fw.WriteFile(infraFilePath, envBytes, 0644) + if err != nil { + log.Printf("warning: failed to write gcp bootstrap env file: %v", err) + } + log.Printf("Infrastructure details written to %s", infraFilePath) } if err != nil { if bs.Env.Jumpbox != nil && bs.Env.Jumpbox.GetExternalIP() != "" { log.Printf("To debug on the jumpbox host:\nssh-add $SSH_KEY_PATH; ssh -o StrictHostKeyChecking=no -o ForwardAgent=yes -o SendEnv=OMS_PORTAL_API_KEY root@%s", bs.Env.Jumpbox.GetExternalIP()) } - return fmt.Errorf("failed to bootstrap GCP: %w, env: %s", err, envString) - } - - workdir := env.NewEnv().GetOmsWorkdir() - err = fw.MkdirAll(workdir, 0755) - if err != nil { - return fmt.Errorf("failed to create workdir: %w", err) - } - infraFilePath := gcp.GetInfraFilePath() - err = fw.WriteFile(infraFilePath, envBytes, 0644) - if err != nil { - return fmt.Errorf("failed to write gcp bootstrap env file: %w", err) + return fmt.Errorf("failed to bootstrap GCP: %w", err) } log.Println("\nšŸŽ‰šŸŽ‰šŸŽ‰ GCP infrastructure bootstrapped successfully!") - log.Printf("Infrastructure details written to %s", infraFilePath) log.Printf("Access the jumpbox using:\nssh-add $SSH_KEY_PATH; ssh -o StrictHostKeyChecking=no -o ForwardAgent=yes -o SendEnv=OMS_PORTAL_API_KEY root@%s", bs.Env.Jumpbox.GetExternalIP()) if bs.Env.InstallVersion != "" { log.Printf("Access Codesphere in your web browser at https://cs.%s", bs.Env.BaseDomain) From 52e0a9a5fad1b40ef8bddf969f4cceb53f75b446 Mon Sep 17 00:00:00 2001 From: Manuel Dewald Date: Mon, 23 Feb 2026 12:37:57 +0100 Subject: [PATCH 2/3] feat!(package): rename oms-cli binary to oms --- .github/workflows/cli-build_test.yml | 10 ++++++++ .github/workflows/service-build_test.yml | 31 ------------------------ .gitignore | 3 +-- .goreleaser.yaml | 22 +---------------- CONTRIBUTING.md | 2 +- Makefile | 17 ++++--------- README.md | 28 ++++++++++----------- cli/cmd/api_key_integration_test.go | 4 +-- cli/cmd/bootstrap_gcp.go | 2 +- cli/cmd/build_image.go | 4 +-- cli/cmd/download_k0s.go | 4 +-- cli/cmd/download_package.go | 4 +-- cli/cmd/example_helpers.go | 10 +++++--- cli/cmd/init_install_config.go | 4 +-- cli/cmd/install_k0s.go | 4 +-- cli/cmd/smoketest_codesphere.go | 4 +-- cli/cmd/update_dockerfile.go | 4 +-- cli/cmd/update_install_config.go | 4 +-- hack/gendocs/main.go | 2 +- hack/lima-oms.yaml | 6 ++--- internal/bootstrap/gcp/gcp.go | 6 ++--- internal/bootstrap/gcp/gcp_test.go | 18 +++++++------- internal/installer/node/node.go | 4 +-- internal/version/version.go | 2 +- service/cmd/root.go | 25 ------------------- service/main.go | 10 -------- 26 files changed, 76 insertions(+), 158 deletions(-) delete mode 100644 .github/workflows/service-build_test.yml delete mode 100644 service/cmd/root.go delete mode 100644 service/main.go diff --git a/.github/workflows/cli-build_test.yml b/.github/workflows/cli-build_test.yml index c2bb0647..bba477e4 100644 --- a/.github/workflows/cli-build_test.yml +++ b/.github/workflows/cli-build_test.yml @@ -30,5 +30,15 @@ jobs: - name: Release Dry-run run: make release-local + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 + + - name: Set up Go + uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6 + with: + go-version-file: 'go.mod' + - name: Test run: make test diff --git a/.github/workflows/service-build_test.yml b/.github/workflows/service-build_test.yml deleted file mode 100644 index 69810331..00000000 --- a/.github/workflows/service-build_test.yml +++ /dev/null @@ -1,31 +0,0 @@ -# Copyright (c) Codesphere Inc. -# SPDX-License-Identifier: Apache-2.0 - -# This workflow will build a golang project -# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go - -name: Build & Test Service - -on: - push: - branches: [ "main" ] - pull_request: - branches: [ "main" ] - -jobs: - - build: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6 - - - name: Set up Go - uses: actions/setup-go@7a3fe6cf4cb3a834922a1244abfce67bcef6a0c5 # v6 - with: - go-version-file: 'go.mod' - - - name: Build - run: make build-service - - - name: Test - run: make test diff --git a/.gitignore b/.gitignore index f0c0f8f3..1dac6edb 100644 --- a/.gitignore +++ b/.gitignore @@ -27,8 +27,7 @@ go.work.sum # bin file bin/ -oms-cli -oms-service +oms dist/ oms-workdir/ diff --git a/.goreleaser.yaml b/.goreleaser.yaml index 7da90a33..97781b5d 100644 --- a/.goreleaser.yaml +++ b/.goreleaser.yaml @@ -18,27 +18,7 @@ builds: - darwin_amd64 - windows_amd64 main: ./cli - binary: oms-cli - ldflags: - - -s -w - - -X github.com/codesphere-cloud/oms/internal/version.version={{.Version}} - - -X github.com/codesphere-cloud/oms/internal/version.commit={{.Commit}} - - -X github.com/codesphere-cloud/oms/internal/version.date={{.Date}} - - -X github.com/codesphere-cloud/oms/internal/version.os={{.Os}} - - -X github.com/codesphere-cloud/oms/internal/version.arch={{.Arch}} - - - id: service - env: - - CGO_ENABLED=0 - targets: - - linux_amd64 - - linux_arm64 - - darwin_arm64 - - darwin_amd64 - - windows_amd64 - - main: ./service - binary: oms-service + binary: oms ldflags: - -s -w - -X github.com/codesphere-cloud/oms/internal/version.version={{.Version}} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d3178fb4..f42d42fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,7 @@ Run the generated `AddInstallComponent()` function in the parent `cli/cmd/instal This will add the following command to the CLI: ``` -oms-cli install component +oms install component ``` ## Contributing Code diff --git a/Makefile b/Makefile index 7cfe50e6..c7d2b497 100644 --- a/Makefile +++ b/Makefile @@ -1,13 +1,9 @@ -all: build-cli build-service +all: build-cli build-cli: - cd cli && go build -v && mv cli ../oms-cli + cd cli && go build -v && mv cli ../oms -build-service: - cd service && go build -v && mv service ../oms-service - -test: - go test -count=1 -v ./... +test: test-cli test-cli: # -count=1 to disable caching test results @@ -17,9 +13,6 @@ test-integration: # Run integration tests with build tag go test -count=1 -v -tags=integration ./cli/... -test-service: - go test -count=1 -v ./service/... - format: go fmt ./... @@ -44,8 +37,8 @@ release-local: install-build-deps docs: rm -rf docs mkdir docs - go run -ldflags="-X 'github.com/codesphere-cloud/oms/internal/version.binName=oms-cli'" hack/gendocs/main.go - cp docs/oms-cli.md docs/README.md + go run -ldflags="-X 'github.com/codesphere-cloud/oms/internal/version.binName=oms'" hack/gendocs/main.go + cp docs/oms.md docs/README.md generate-license: generate go tool go-licenses report --template .NOTICE.template ./... > NOTICE diff --git a/README.md b/README.md index fc84da25..cf0707ea 100644 --- a/README.md +++ b/README.md @@ -24,15 +24,15 @@ Note that some commands may require you to elevate to the root user with `sudo`. ##### ARM Mac ``` -gh release download -R codesphere-cloud/oms -O /usr/local/bin/oms-cli -p "oms-cli*darwin_arm64" -chmod +x /usr/local/bin/oms-cli +gh release download -R codesphere-cloud/oms -O /usr/local/bin/oms -p "oms*darwin_arm64" +chmod +x /usr/local/bin/oms ``` ##### Linux Amd64 ``` -gh release download -R codesphere-cloud/oms -O /usr/local/bin/oms-cli -p "oms-cli*linux_amd64" -chmod +x /usr/local/bin/oms-cli +gh release download -R codesphere-cloud/oms -O /usr/local/bin/oms -p "oms*linux_amd64" +chmod +x /usr/local/bin/oms ``` #### Using `wget` @@ -43,17 +43,17 @@ Note that some commands may require you to elevate to the root user with `sudo`. ##### ARM Mac ``` -wget -qO- 'https://api.github.com/repos/codesphere-cloud/oms/releases/latest' | jq -r '.assets[] | select(.name | match("oms-cli.*darwin_arm64")) | .browser_download_url' | xargs wget -O oms-cli -mv oms-cli /usr/local/bin/oms-cli -chmod +x /usr/local/bin/oms-cli +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 ``` ##### Linux Amd64 ``` -wget -qO- 'https://api.github.com/repos/codesphere-cloud/oms/releases/latest' | jq -r '.assets[] | select(.name | match("oms-cli.*linux_amd64")) | .browser_download_url' | xargs wget -O oms-cli -mv oms-cli /usr/local/bin/oms-cli -chmod +x /usr/local/bin/oms-cli +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 @@ -61,13 +61,13 @@ chmod +x /usr/local/bin/oms-cli You can also download the pre-compiled binaries from the [OMS Releases page](https://github.com/codesphere-cloud/oms/releases). Note that some commands may require you to elevate to the root user with `sudo`. -1. Go to the [latest release](https://github.com/codesphere-cloud/oms-cli/releases/latest). +1. Go to the [latest release](https://github.com/codesphere-cloud/oms/releases/latest). -2. Download the appropriate release for your operating system and architecture (e.g., `oms-cli_darwin_amd64` for macOS, `oms-cli_linux_amd64` for Linux, or `oms-cli_windows_amd64` for Windows). +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-cli` 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). +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-cli` on Mac or Linux) +4. Make the binary executable (e.g. by running `chmod +x /usr/local/bin/oms` on Mac or Linux) #### Available Commands diff --git a/cli/cmd/api_key_integration_test.go b/cli/cmd/api_key_integration_test.go index bb49b23a..e54b8a27 100644 --- a/cli/cmd/api_key_integration_test.go +++ b/cli/cmd/api_key_integration_test.go @@ -231,7 +231,7 @@ var _ = Describe("API Key Integration Tests", func() { Describe("Old API Key Detection and Warning", func() { var ( - cliPath = "../../oms-cli" + cliPath = "../../oms" ) Context("when using a 25-character old API key format", func() { @@ -310,7 +310,7 @@ var _ = Describe("API Key Integration Tests", func() { Describe("PreRun Hook Execution", func() { var ( - cliPath = "../../oms-cli" + cliPath = "../../oms" ) Context("when running any OMS command", func() { diff --git a/cli/cmd/bootstrap_gcp.go b/cli/cmd/bootstrap_gcp.go index 482dd232..d0548e24 100644 --- a/cli/cmd/bootstrap_gcp.go +++ b/cli/cmd/bootstrap_gcp.go @@ -152,7 +152,7 @@ func (c *BootstrapGcpCmd) BootstrapGcp() error { return nil } packageName := "-installer" - installCmd := "oms-cli install codesphere -c /etc/codesphere/config.yaml -k /etc/codesphere/secrets/age_key.txt" + installCmd := "oms install codesphere -c /etc/codesphere/config.yaml -k /etc/codesphere/secrets/age_key.txt" if gcp.RegistryType(bs.Env.RegistryType) == gcp.RegistryTypeGitHub { log.Printf("You set a GitHub PAT for direct image access. Make sure to use a lite package, as VM root disk sizes are reduced.") installCmd += " -s load-container-images" diff --git a/cli/cmd/build_image.go b/cli/cmd/build_image.go index cec20f60..5769293d 100644 --- a/cli/cmd/build_image.go +++ b/cli/cmd/build_image.go @@ -44,9 +44,9 @@ func AddBuildImageCmd(parentCmd *cobra.Command, opts *GlobalOptions) { Use: "image", Short: "Build and push Docker image using Dockerfile and Codesphere package version", Long: `Build a Docker image from a Dockerfile and push it to a registry, tagged with the Codesphere version from the package.`, - Example: formatExamplesWithBinary("build image", []io.Example{ + Example: formatExamples("build image", []io.Example{ {Cmd: "--dockerfile baseimage/Dockerfile --package codesphere-v1.68.0.tar.gz --registry my-registry.com/my-image", Desc: "Build image for Codesphere version 1.68.0 and push to specified registry"}, - }, "oms-cli"), + }), Args: cobra.ExactArgs(0), }, Opts: BuildImageOpts{GlobalOptions: opts}, diff --git a/cli/cmd/download_k0s.go b/cli/cmd/download_k0s.go index 414684a7..68b4bd10 100644 --- a/cli/cmd/download_k0s.go +++ b/cli/cmd/download_k0s.go @@ -51,12 +51,12 @@ func AddDownloadK0sCmd(download *cobra.Command, opts *GlobalOptions) { Short: "Download k0s Kubernetes distribution", Long: packageio.Long(`Download a k0s binary directly to the OMS workdir. Will download the latest version if no version is specified.`), - Example: formatExamplesWithBinary("download k0s", []packageio.Example{ + Example: formatExamples("download k0s", []packageio.Example{ {Cmd: "", Desc: "Download k0s using the Go-native implementation"}, {Cmd: "--version 1.22.0", Desc: "Download a specific version of k0s"}, {Cmd: "--quiet", Desc: "Download k0s with minimal output"}, {Cmd: "--force", Desc: "Force download even if k0s binary exists"}, - }, "oms-cli"), + }), }, Opts: DownloadK0sOpts{GlobalOptions: opts}, Env: env.NewEnv(), diff --git a/cli/cmd/download_package.go b/cli/cmd/download_package.go index 8a4d0e63..36b090cb 100644 --- a/cli/cmd/download_package.go +++ b/cli/cmd/download_package.go @@ -61,11 +61,11 @@ func AddDownloadPackageCmd(download *cobra.Command, opts *GlobalOptions) { Short: "Download a codesphere package", Long: io.Long(`Download a specific version of a Codesphere package To list available packages, run oms list packages.`), - Example: formatExamplesWithBinary("download package", []io.Example{ + Example: formatExamples("download package", []io.Example{ {Cmd: "codesphere-v1.55.0", Desc: "Download Codesphere version 1.55.0"}, {Cmd: "--version codesphere-v1.55.0", Desc: "Download Codesphere version 1.55.0"}, {Cmd: "--version codesphere-v1.55.0 --file installer-lite.tar.gz", Desc: "Download lite package of Codesphere version 1.55.0"}, - }, "oms-cli"), + }), PreRunE: func(cmd *cobra.Command, args []string) error { // if version flag is not set, expect version as argument cmd.Args = cobra.NoArgs diff --git a/cli/cmd/example_helpers.go b/cli/cmd/example_helpers.go index 24e0f2f4..04c2f993 100644 --- a/cli/cmd/example_helpers.go +++ b/cli/cmd/example_helpers.go @@ -7,11 +7,12 @@ import ( "strings" "github.com/codesphere-cloud/cs-go/pkg/io" + "github.com/codesphere-cloud/oms/internal/version" ) -// formatExamplesWithBinary builds an Example string similar to io.FormatExampleCommands -// but prefixes commands with a stable binary name (e.g. "oms-cli") instead of temporary go-build paths -func formatExamplesWithBinary(cmdName string, examples []io.Example, binaryName string) string { +// formatExamples builds an Example string similar to io.FormatExampleCommands +// it prefixes commands with a stable binary name (e.g. "oms") instead of temporary go-build paths +func formatExamples(cmdName string, examples []io.Example) string { var b strings.Builder for i, ex := range examples { if ex.Desc != "" { @@ -20,7 +21,8 @@ func formatExamplesWithBinary(cmdName string, examples []io.Example, binaryName b.WriteString("\n") } b.WriteString("$ ") - b.WriteString(binaryName) + build := version.Build{} + b.WriteString(build.BinName()) b.WriteString(" ") b.WriteString(cmdName) if ex.Cmd != "" { diff --git a/cli/cmd/init_install_config.go b/cli/cmd/init_install_config.go index b1409628..d4b59645 100644 --- a/cli/cmd/init_install_config.go +++ b/cli/cmd/init_install_config.go @@ -119,12 +119,12 @@ func AddInitInstallConfigCmd(init *cobra.Command, opts *GlobalOptions) { - dev: Single-node development setup - production: HA multi-node setup - minimal: Minimal testing setup`), - Example: formatExamplesWithBinary("init install-config", []csio.Example{ + Example: formatExamples("init install-config", []csio.Example{ {Cmd: "-c config.yaml --vault prod.vault.yaml", Desc: "Create config files interactively"}, {Cmd: "--profile dev -c config.yaml --vault prod.vault.yaml", Desc: "Use dev profile with defaults"}, {Cmd: "--profile production -c config.yaml --vault prod.vault.yaml", Desc: "Use production profile"}, {Cmd: "--validate -c config.yaml --vault prod.vault.yaml", Desc: "Validate existing configuration files"}, - }, "oms-cli"), + }), }, Opts: &InitInstallConfigOpts{GlobalOptions: opts}, FileWriter: util.NewFilesystemWriter(), diff --git a/cli/cmd/install_k0s.go b/cli/cmd/install_k0s.go index a5139330..388fe8b9 100644 --- a/cli/cmd/install_k0s.go +++ b/cli/cmd/install_k0s.go @@ -55,13 +55,13 @@ func AddInstallK0sCmd(install *cobra.Command, opts *GlobalOptions) { or load the k0s binary from the provided package file and install it. If no version is specified, the latest version will be downloaded. If no install config is provided, k0s will be installed with the '--single' flag.`), - Example: formatExamplesWithBinary("install k0s", []packageio.Example{ + Example: formatExamples("install k0s", []packageio.Example{ {Cmd: "", Desc: "Install k0s using the Go-native implementation"}, {Cmd: "--version ", Desc: "Version of k0s to install"}, {Cmd: "--package ", Desc: "Package file (e.g. codesphere-v1.2.3-installer.tar.gz) to load k0s from"}, {Cmd: "--k0s-config ", Desc: "Path to k0s configuration file, if not set k0s will be installed with the '--single' flag"}, {Cmd: "--force", Desc: "Force new download and installation even if k0s binary exists or is already installed"}, - }, "oms-cli"), + }), }, Opts: InstallK0sOpts{GlobalOptions: opts}, Env: env.NewEnv(), diff --git a/cli/cmd/smoketest_codesphere.go b/cli/cmd/smoketest_codesphere.go index 586d03c6..5a6197cc 100644 --- a/cli/cmd/smoketest_codesphere.go +++ b/cli/cmd/smoketest_codesphere.go @@ -63,7 +63,7 @@ func AddSmoketestCodesphereCmd(parent *cobra.Command, opts *GlobalOptions) { Long: io.Long(`Run automated smoke tests for a Codesphere installation by creating a workspace, setting environment variables, executing commands, syncing landscape, and running a pipeline stage. The workspace is automatically deleted after the test completes.`), - Example: formatExamplesWithBinary("smoketest codesphere", []io.Example{ + Example: formatExamples("smoketest codesphere", []io.Example{ { Cmd: "--baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID", Desc: "Run smoke tests against a Codesphere installation", @@ -84,7 +84,7 @@ func AddSmoketestCodesphereCmd(parent *cobra.Command, opts *GlobalOptions) { Cmd: "--baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID --steps createWorkspace,syncLandscape,deleteWorkspace", Desc: "Run specific steps and delete the workspace afterwards", }, - }, "oms-cli"), + }), }, Opts: &teststeps.SmoketestCodesphereOpts{}, } diff --git a/cli/cmd/update_dockerfile.go b/cli/cmd/update_dockerfile.go index 8e9ab1b5..69f85012 100644 --- a/cli/cmd/update_dockerfile.go +++ b/cli/cmd/update_dockerfile.go @@ -57,10 +57,10 @@ func AddUpdateDockerfileCmd(parentCmd *cobra.Command, opts *GlobalOptions) { This command extracts the base image from a Codesphere package and updates the FROM statement in the specified Dockerfile to use that base image. The base image is loaded into the local Docker daemon so it can be used for building.`, - Example: formatExamplesWithBinary("update dockerfile", []io.Example{ + Example: formatExamples("update dockerfile", []io.Example{ {Cmd: "--dockerfile baseimage/Dockerfile --package codesphere-v1.68.0.tar.gz", Desc: "Update Dockerfile to use the default base image from the package (workspace-agent-24.04)"}, {Cmd: "--dockerfile baseimage/Dockerfile --package codesphere-v1.68.0.tar.gz --baseimage workspace-agent-20.04.tar", Desc: "Update Dockerfile to use the workspace-agent-20.04 base image from the package"}, - }, "oms-cli"), + }), Args: cobra.ExactArgs(0), }, Opts: UpdateDockerfileOpts{GlobalOptions: opts}, diff --git a/cli/cmd/update_install_config.go b/cli/cmd/update_install_config.go index 66cc6df3..b51829f6 100644 --- a/cli/cmd/update_install_config.go +++ b/cli/cmd/update_install_config.go @@ -82,11 +82,11 @@ func AddUpdateInstallConfigCmd(update *cobra.Command, opts *GlobalOptions) { For example, updating the PostgreSQL primary IP will trigger regeneration of the PostgreSQL server certificates that include that IP address.`), - Example: formatExamplesWithBinary("update install-config", []csio.Example{ + Example: formatExamples("update install-config", []csio.Example{ {Cmd: "--postgres-primary-ip 10.10.0.4 --config config.yaml --vault prod.vault.yaml", Desc: "Update PostgreSQL primary IP and regenerate certificates"}, {Cmd: "--domain new.example.com --config config.yaml --vault prod.vault.yaml", Desc: "Update Codesphere domain"}, {Cmd: "--k8s-api-server 10.0.0.10 --config config.yaml --vault prod.vault.yaml", Desc: "Update Kubernetes API server host"}, - }, "oms-cli"), + }), }, Opts: &UpdateInstallConfigOpts{GlobalOptions: opts}, FileWriter: util.NewFilesystemWriter(), diff --git a/hack/gendocs/main.go b/hack/gendocs/main.go index a59cd3a0..624ee095 100644 --- a/hack/gendocs/main.go +++ b/hack/gendocs/main.go @@ -13,7 +13,7 @@ import ( func main() { // Ensure the generated docs use the stable project command name. root := oms.GetRootCmd() - root.Use = "oms-cli" + root.Use = "oms" root.DisableAutoGenTag = true diff --git a/hack/lima-oms.yaml b/hack/lima-oms.yaml index 8dabfd2b..ca8e2c38 100644 --- a/hack/lima-oms.yaml +++ b/hack/lima-oms.yaml @@ -67,7 +67,7 @@ provision: cd /home/user/oms export PATH=$PATH:/usr/local/go/bin go mod download - cd cli && go build -a -buildvcs=false && mv cli ../oms-cli + cd cli && go build -a -buildvcs=false && mv cli ../oms message: | Your OMS development environment is ready! @@ -76,12 +76,12 @@ message: | ------ limactl shell lima-oms cd /home/user/oms - ./oms-cli --help + ./oms --help ------ To install Codesphere eg.: ------ - ./oms-cli install codesphere --package codesphere-v1.66.0-installer --config config.yaml --priv-key ./path-to-private-key + ./oms install codesphere --package codesphere-v1.66.0-installer --config config.yaml --priv-key ./path-to-private-key ------ Go 1.24 and Docker are installed and ready to use. diff --git a/internal/bootstrap/gcp/gcp.go b/internal/bootstrap/gcp/gcp.go index bbcc6ab8..b8def9cf 100644 --- a/internal/bootstrap/gcp/gcp.go +++ b/internal/bootstrap/gcp/gcp.go @@ -916,7 +916,7 @@ func (b *GCPBootstrapper) EnsureJumpboxConfigured() error { } } - hasOms := b.Env.Jumpbox.HasCommand("oms-cli") + hasOms := b.Env.Jumpbox.HasCommand("oms") if hasOms { return nil } @@ -1412,7 +1412,7 @@ func (b *GCPBootstrapper) InstallCodesphere() error { skipStepsArg = " -s " + strings.Join(skipSteps, ",") } - downloadCmd := "oms-cli download package -f " + packageFile + downloadCmd := "oms download package -f " + packageFile if b.Env.InstallHash != "" { downloadCmd += " -H " + b.Env.InstallHash } @@ -1423,7 +1423,7 @@ func (b *GCPBootstrapper) InstallCodesphere() error { } fullPackageFilename := portal.BuildPackageFilenameFromParts(b.Env.InstallVersion, b.Env.InstallHash, packageFile) - installCmd := fmt.Sprintf("oms-cli install codesphere -c /etc/codesphere/config.yaml -k %s/age_key.txt -p %s%s", + installCmd := fmt.Sprintf("oms install codesphere -c /etc/codesphere/config.yaml -k %s/age_key.txt -p %s%s", b.Env.SecretsDir, fullPackageFilename, skipStepsArg) err = b.Env.Jumpbox.RunSSHCommand("root", installCmd) if err != nil { diff --git a/internal/bootstrap/gcp/gcp_test.go b/internal/bootstrap/gcp/gcp_test.go index 1a231540..05abe866 100644 --- a/internal/bootstrap/gcp/gcp_test.go +++ b/internal/bootstrap/gcp/gcp_test.go @@ -1397,11 +1397,11 @@ var _ = Describe("GCP Bootstrapper", func() { }) It("downloads and installs lite package", func() { // Expect download package - nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms-cli download package -f installer-lite.tar.gz -H abc1234567890 v1.2.3").Return(nil) + nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms download package -f installer-lite.tar.gz -H abc1234567890 v1.2.3").Return(nil) // Expect install codesphere nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", - "oms-cli install codesphere -c /etc/codesphere/config.yaml -k /etc/codesphere/secrets/age_key.txt -p v1.2.3-abc1234567890-installer-lite.tar.gz -s load-container-images").Return(nil) + "oms install codesphere -c /etc/codesphere/config.yaml -k /etc/codesphere/secrets/age_key.txt -p v1.2.3-abc1234567890-installer-lite.tar.gz -s load-container-images").Return(nil) err := bs.InstallCodesphere() Expect(err).NotTo(HaveOccurred()) @@ -1415,10 +1415,10 @@ var _ = Describe("GCP Bootstrapper", func() { }) It("downloads and installs codesphere", func() { // Expect download package - nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms-cli download package -f installer.tar.gz -H def9876543210 v1.2.3").Return(nil) + nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms download package -f installer.tar.gz -H def9876543210 v1.2.3").Return(nil) // Expect install codesphere - nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms-cli install codesphere -c /etc/codesphere/config.yaml -k /etc/codesphere/secrets/age_key.txt -p v1.2.3-def9876543210-installer.tar.gz").Return(nil) + nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms install codesphere -c /etc/codesphere/config.yaml -k /etc/codesphere/secrets/age_key.txt -p v1.2.3-def9876543210-installer.tar.gz").Return(nil) err := bs.InstallCodesphere() Expect(err).NotTo(HaveOccurred()) @@ -1426,8 +1426,8 @@ var _ = Describe("GCP Bootstrapper", func() { }) It("downloads and installs codesphere with hash", func() { - nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms-cli download package -f installer.tar.gz -H abc1234567890 v1.2.3").Return(nil) - nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms-cli install codesphere -c /etc/codesphere/config.yaml -k /etc/codesphere/secrets/age_key.txt -p v1.2.3-abc1234567890-installer.tar.gz").Return(nil) + nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms download package -f installer.tar.gz -H abc1234567890 v1.2.3").Return(nil) + nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms install codesphere -c /etc/codesphere/config.yaml -k /etc/codesphere/secrets/age_key.txt -p v1.2.3-abc1234567890-installer.tar.gz").Return(nil) err := bs.InstallCodesphere() Expect(err).NotTo(HaveOccurred()) @@ -1436,7 +1436,7 @@ var _ = Describe("GCP Bootstrapper", func() { Describe("Invalid cases", func() { It("fails when download package fails", func() { - nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms-cli download package -f installer.tar.gz -H abc1234567890 v1.2.3").Return(fmt.Errorf("download error")) + nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms download package -f installer.tar.gz -H abc1234567890 v1.2.3").Return(fmt.Errorf("download error")) err := bs.InstallCodesphere() Expect(err).To(HaveOccurred()) @@ -1444,8 +1444,8 @@ var _ = Describe("GCP Bootstrapper", func() { }) It("fails when install codesphere fails", func() { - nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms-cli download package -f installer.tar.gz -H abc1234567890 v1.2.3").Return(nil).Once() - nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms-cli install codesphere -c /etc/codesphere/config.yaml -k /etc/codesphere/secrets/age_key.txt -p v1.2.3-abc1234567890-installer.tar.gz").Return(fmt.Errorf("install error")).Once() + nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms download package -f installer.tar.gz -H abc1234567890 v1.2.3").Return(nil).Once() + nodeClient.EXPECT().RunCommand(mock.MatchedBy(jumpbboxMatcher), "root", "oms install codesphere -c /etc/codesphere/config.yaml -k /etc/codesphere/secrets/age_key.txt -p v1.2.3-abc1234567890-installer.tar.gz").Return(fmt.Errorf("install error")).Once() err := bs.InstallCodesphere() Expect(err).To(HaveOccurred()) diff --git a/internal/installer/node/node.go b/internal/installer/node/node.go index 0262df3a..578dfde3 100644 --- a/internal/installer/node/node.go +++ b/internal/installer/node/node.go @@ -191,8 +191,8 @@ func (n *Node) HasCommand(command string) bool { // InstallOms installs the OMS CLI on the remote node via SSH func (n *Node) InstallOms() error { remoteCommands := []string{ - "wget -qO- 'https://api.github.com/repos/codesphere-cloud/oms/releases/latest' | jq -r '.assets[] | select(.name | match(\"oms-cli.*linux_amd64\")) | .browser_download_url' | xargs wget -O oms-cli", - "chmod +x oms-cli; sudo mv oms-cli /usr/local/bin/", + "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", + "chmod +x oms; sudo mv oms /usr/local/bin/", "curl -LO https://github.com/getsops/sops/releases/download/v3.11.0/sops-v3.11.0.linux.amd64; sudo mv sops-v3.11.0.linux.amd64 /usr/local/bin/sops; sudo chmod +x /usr/local/bin/sops", "wget https://dl.filippo.io/age/latest?for=linux/amd64 -O age.tar.gz; tar -xvf age.tar.gz; sudo mv age/age* /usr/local/bin/", } diff --git a/internal/version/version.go b/internal/version/version.go index ecd0fd42..03c2c863 100644 --- a/internal/version/version.go +++ b/internal/version/version.go @@ -10,7 +10,7 @@ var ( date string = "unknown" os string = "unknown" arch string = "unknown" - binName string = "oms-cli" + binName string = "oms" ) type Version interface { diff --git a/service/cmd/root.go b/service/cmd/root.go deleted file mode 100644 index 60f87ac9..00000000 --- a/service/cmd/root.go +++ /dev/null @@ -1,25 +0,0 @@ -// Copyright (c) Codesphere Inc. -// SPDX-License-Identifier: Apache-2.0 -package cmd - -import ( - "os" - - "github.com/codesphere-cloud/cs-go/pkg/io" - "github.com/spf13/cobra" -) - -func Execute() { - rootCmd := &cobra.Command{ - Use: "service", - Short: "Codesphere Operations Management System", - Long: io.Long(`This is the OMS standalone service, which can be used to manage and observe Codesphere installations. - - This area is work in progress! OMS is under heavy development so please take a look back soon!`), - } - - err := rootCmd.Execute() - if err != nil { - os.Exit(1) - } -} diff --git a/service/main.go b/service/main.go deleted file mode 100644 index 35c6dd3b..00000000 --- a/service/main.go +++ /dev/null @@ -1,10 +0,0 @@ -// Copyright (c) Codesphere Inc. -// SPDX-License-Identifier: Apache-2.0 - -package main - -import "github.com/codesphere-cloud/oms/service/cmd" - -func main() { - cmd.Execute() -} From 84219230d60fa7e7e2c291e1be6b4a17cd8c6ae0 Mon Sep 17 00:00:00 2001 From: NautiluX <2600004+NautiluX@users.noreply.github.com> Date: Thu, 26 Feb 2026 15:00:03 +0000 Subject: [PATCH 3/3] chore(docs): Auto-update docs and licenses Signed-off-by: NautiluX <2600004+NautiluX@users.noreply.github.com> --- docs/README.md | 28 ++++++++-------- docs/oms-cli.md | 32 ------------------- docs/oms-cli_beta.md | 21 ------------ docs/oms-cli_build.md | 20 ------------ docs/oms-cli_download.md | 21 ------------ docs/oms-cli_init.md | 19 ----------- docs/oms-cli_install.md | 20 ------------ docs/oms-cli_list.md | 21 ------------ docs/oms-cli_update.md | 23 ------------- docs/oms.md | 32 +++++++++++++++++++ docs/oms_beta.md | 21 ++++++++++++ ...strap-gcp.md => oms_beta_bootstrap-gcp.md} | 8 ++--- ...d => oms_beta_bootstrap-gcp_postconfig.md} | 6 ++-- ...-cli_beta_extend.md => oms_beta_extend.md} | 6 ++-- ...eimage.md => oms_beta_extend_baseimage.md} | 6 ++-- docs/oms_build.md | 20 ++++++++++++ ...-cli_build_image.md => oms_build_image.md} | 8 ++--- ...li_build_images.md => oms_build_images.md} | 6 ++-- docs/oms_download.md | 21 ++++++++++++ ...li_download_k0s.md => oms_download_k0s.md} | 14 ++++---- ...ate_package.md => oms_download_package.md} | 12 +++---- docs/oms_init.md | 19 +++++++++++ ...l-config.md => oms_init_install-config.md} | 14 ++++---- docs/oms_install.md | 20 ++++++++++++ ...odesphere.md => oms_install_codesphere.md} | 6 ++-- ...-cli_install_k0s.md => oms_install_k0s.md} | 16 +++++----- docs/{oms-cli_licenses.md => oms_licenses.md} | 6 ++-- docs/oms_list.md | 21 ++++++++++++ ..._list_api-keys.md => oms_list_api-keys.md} | 6 ++-- ..._list_packages.md => oms_list_packages.md} | 6 ++-- docs/{oms-cli_register.md => oms_register.md} | 6 ++-- docs/{oms-cli_revoke.md => oms_revoke.md} | 6 ++-- ...evoke_api-key.md => oms_revoke_api-key.md} | 6 ++-- ...{oms-cli_smoketest.md => oms_smoketest.md} | 6 ++-- ...esphere.md => oms_smoketest_codesphere.md} | 16 +++++----- docs/oms_update.md | 23 +++++++++++++ ...pdate_api-key.md => oms_update_api-key.md} | 6 ++-- ...dockerfile.md => oms_update_dockerfile.md} | 10 +++--- ...config.md => oms_update_install-config.md} | 12 +++---- ...ms-cli_update_oms.md => oms_update_oms.md} | 6 ++-- ...nload_package.md => oms_update_package.md} | 12 +++---- docs/{oms-cli_version.md => oms_version.md} | 6 ++-- 42 files changed, 297 insertions(+), 297 deletions(-) delete mode 100644 docs/oms-cli.md delete mode 100644 docs/oms-cli_beta.md delete mode 100644 docs/oms-cli_build.md delete mode 100644 docs/oms-cli_download.md delete mode 100644 docs/oms-cli_init.md delete mode 100644 docs/oms-cli_install.md delete mode 100644 docs/oms-cli_list.md delete mode 100644 docs/oms-cli_update.md create mode 100644 docs/oms.md create mode 100644 docs/oms_beta.md rename docs/{oms-cli_beta_bootstrap-gcp.md => oms_beta_bootstrap-gcp.md} (93%) rename docs/{oms-cli_beta_bootstrap-gcp_postconfig.md => oms_beta_bootstrap-gcp_postconfig.md} (74%) rename docs/{oms-cli_beta_extend.md => oms_beta_extend.md} (50%) rename docs/{oms-cli_beta_extend_baseimage.md => oms_beta_extend_baseimage.md} (84%) create mode 100644 docs/oms_build.md rename docs/{oms-cli_build_image.md => oms_build_image.md} (74%) rename docs/{oms-cli_build_images.md => oms_build_images.md} (77%) create mode 100644 docs/oms_download.md rename docs/{oms-cli_download_k0s.md => oms_download_k0s.md} (70%) rename docs/{oms-cli_update_package.md => oms_download_package.md} (68%) create mode 100644 docs/oms_init.md rename docs/{oms-cli_init_install-config.md => oms_init_install-config.md} (87%) create mode 100644 docs/oms_install.md rename docs/{oms-cli_install_codesphere.md => oms_install_codesphere.md} (84%) rename docs/{oms-cli_install_k0s.md => oms_install_k0s.md} (78%) rename docs/{oms-cli_licenses.md => oms_licenses.md} (63%) create mode 100644 docs/oms_list.md rename docs/{oms-cli_list_api-keys.md => oms_list_api-keys.md} (54%) rename docs/{oms-cli_list_packages.md => oms_list_packages.md} (57%) rename docs/{oms-cli_register.md => oms_register.md} (82%) rename docs/{oms-cli_revoke.md => oms_revoke.md} (53%) rename docs/{oms-cli_revoke_api-key.md => oms_revoke_api-key.md} (57%) rename docs/{oms-cli_smoketest.md => oms_smoketest.md} (50%) rename docs/{oms-cli_smoketest_codesphere.md => oms_smoketest_codesphere.md} (60%) create mode 100644 docs/oms_update.md rename docs/{oms-cli_update_api-key.md => oms_update_api-key.md} (75%) rename docs/{oms-cli_update_dockerfile.md => oms_update_dockerfile.md} (73%) rename docs/{oms-cli_update_install-config.md => oms_update_install-config.md} (87%) rename docs/{oms-cli_update_oms.md => oms_update_oms.md} (58%) rename docs/{oms-cli_download_package.md => oms_update_package.md} (67%) rename docs/{oms-cli_version.md => oms_version.md} (54%) diff --git a/docs/README.md b/docs/README.md index 8cd34e59..a47a666a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,4 +1,4 @@ -## oms-cli +## oms Codesphere Operations Management System (OMS) @@ -12,21 +12,21 @@ like downloading new versions. ### Options ``` - -h, --help help for oms-cli + -h, --help help for oms ``` ### SEE ALSO -* [oms-cli beta](oms-cli_beta.md) - Commands for early testing -* [oms-cli build](oms-cli_build.md) - Build and push images to a registry -* [oms-cli download](oms-cli_download.md) - Download resources available through OMS -* [oms-cli init](oms-cli_init.md) - Initialize configuration files -* [oms-cli install](oms-cli_install.md) - Install Codesphere and other components -* [oms-cli licenses](oms-cli_licenses.md) - Print license information -* [oms-cli list](oms-cli_list.md) - List resources available through OMS -* [oms-cli register](oms-cli_register.md) - Register a new API key -* [oms-cli revoke](oms-cli_revoke.md) - Revoke resources available through OMS -* [oms-cli smoketest](oms-cli_smoketest.md) - Run smoke tests for Codesphere components -* [oms-cli update](oms-cli_update.md) - Update OMS related resources -* [oms-cli version](oms-cli_version.md) - Print version +* [oms beta](oms_beta.md) - Commands for early testing +* [oms build](oms_build.md) - Build and push images to a registry +* [oms download](oms_download.md) - Download resources available through OMS +* [oms init](oms_init.md) - Initialize configuration files +* [oms install](oms_install.md) - Install Codesphere and other components +* [oms licenses](oms_licenses.md) - Print license information +* [oms list](oms_list.md) - List resources available through OMS +* [oms register](oms_register.md) - Register a new API key +* [oms revoke](oms_revoke.md) - Revoke resources available through OMS +* [oms smoketest](oms_smoketest.md) - Run smoke tests for Codesphere components +* [oms update](oms_update.md) - Update OMS related resources +* [oms version](oms_version.md) - Print version diff --git a/docs/oms-cli.md b/docs/oms-cli.md deleted file mode 100644 index 8cd34e59..00000000 --- a/docs/oms-cli.md +++ /dev/null @@ -1,32 +0,0 @@ -## oms-cli - -Codesphere Operations Management System (OMS) - -### Synopsis - -Codesphere Operations Management System (OMS) - -This command can be used to run common tasks related to managing codesphere installations, -like downloading new versions. - -### Options - -``` - -h, --help help for oms-cli -``` - -### SEE ALSO - -* [oms-cli beta](oms-cli_beta.md) - Commands for early testing -* [oms-cli build](oms-cli_build.md) - Build and push images to a registry -* [oms-cli download](oms-cli_download.md) - Download resources available through OMS -* [oms-cli init](oms-cli_init.md) - Initialize configuration files -* [oms-cli install](oms-cli_install.md) - Install Codesphere and other components -* [oms-cli licenses](oms-cli_licenses.md) - Print license information -* [oms-cli list](oms-cli_list.md) - List resources available through OMS -* [oms-cli register](oms-cli_register.md) - Register a new API key -* [oms-cli revoke](oms-cli_revoke.md) - Revoke resources available through OMS -* [oms-cli smoketest](oms-cli_smoketest.md) - Run smoke tests for Codesphere components -* [oms-cli update](oms-cli_update.md) - Update OMS related resources -* [oms-cli version](oms-cli_version.md) - Print version - diff --git a/docs/oms-cli_beta.md b/docs/oms-cli_beta.md deleted file mode 100644 index e3969f8d..00000000 --- a/docs/oms-cli_beta.md +++ /dev/null @@ -1,21 +0,0 @@ -## oms-cli beta - -Commands for early testing - -### Synopsis - -OMS CLI commands for early adoption and testing. -Be aware that that usage and behavior may change as the features are developed. - -### Options - -``` - -h, --help help for beta -``` - -### SEE ALSO - -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -* [oms-cli beta bootstrap-gcp](oms-cli_beta_bootstrap-gcp.md) - Bootstrap GCP infrastructure for Codesphere -* [oms-cli beta extend](oms-cli_beta_extend.md) - Extend Codesphere ressources such as base images. - diff --git a/docs/oms-cli_build.md b/docs/oms-cli_build.md deleted file mode 100644 index 76481ada..00000000 --- a/docs/oms-cli_build.md +++ /dev/null @@ -1,20 +0,0 @@ -## oms-cli build - -Build and push images to a registry - -### Synopsis - -Build and push container images to a registry using the provided configuration. - -### Options - -``` - -h, --help help for build -``` - -### SEE ALSO - -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -* [oms-cli build image](oms-cli_build_image.md) - Build and push Docker image using Dockerfile and Codesphere package version -* [oms-cli build images](oms-cli_build_images.md) - Build and push container images - diff --git a/docs/oms-cli_download.md b/docs/oms-cli_download.md deleted file mode 100644 index 236f45ff..00000000 --- a/docs/oms-cli_download.md +++ /dev/null @@ -1,21 +0,0 @@ -## oms-cli download - -Download resources available through OMS - -### Synopsis - -Download resources managed by or available for OMS, -e.g. available Codesphere packages - -### Options - -``` - -h, --help help for download -``` - -### SEE ALSO - -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -* [oms-cli download k0s](oms-cli_download_k0s.md) - Download k0s Kubernetes distribution -* [oms-cli download package](oms-cli_download_package.md) - Download a codesphere package - diff --git a/docs/oms-cli_init.md b/docs/oms-cli_init.md deleted file mode 100644 index 08b8b3bb..00000000 --- a/docs/oms-cli_init.md +++ /dev/null @@ -1,19 +0,0 @@ -## oms-cli init - -Initialize configuration files - -### Synopsis - -Initialize configuration files for Codesphere installation and other components. - -### Options - -``` - -h, --help help for init -``` - -### SEE ALSO - -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -* [oms-cli init install-config](oms-cli_init_install-config.md) - Initialize Codesphere installer configuration files - diff --git a/docs/oms-cli_install.md b/docs/oms-cli_install.md deleted file mode 100644 index aff67469..00000000 --- a/docs/oms-cli_install.md +++ /dev/null @@ -1,20 +0,0 @@ -## oms-cli install - -Install Codesphere and other components - -### Synopsis - -Install Codesphere and other components like Ceph and PostgreSQL. - -### Options - -``` - -h, --help help for install -``` - -### SEE ALSO - -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -* [oms-cli install codesphere](oms-cli_install_codesphere.md) - Install a Codesphere instance -* [oms-cli install k0s](oms-cli_install_k0s.md) - Install k0s Kubernetes distribution - diff --git a/docs/oms-cli_list.md b/docs/oms-cli_list.md deleted file mode 100644 index 0d5a7c4b..00000000 --- a/docs/oms-cli_list.md +++ /dev/null @@ -1,21 +0,0 @@ -## oms-cli list - -List resources available through OMS - -### Synopsis - -List resources managed by or available for OMS, -eg. available Codesphere packages - -### Options - -``` - -h, --help help for list -``` - -### SEE ALSO - -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -* [oms-cli list api-keys](oms-cli_list_api-keys.md) - List API keys -* [oms-cli list packages](oms-cli_list_packages.md) - List available packages - diff --git a/docs/oms-cli_update.md b/docs/oms-cli_update.md deleted file mode 100644 index 608d447a..00000000 --- a/docs/oms-cli_update.md +++ /dev/null @@ -1,23 +0,0 @@ -## oms-cli update - -Update OMS related resources - -### Synopsis - -Updates resources, e.g. OMS or OMS API keys. - -### Options - -``` - -h, --help help for update -``` - -### SEE ALSO - -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -* [oms-cli update api-key](oms-cli_update_api-key.md) - Update an API key's expiration date -* [oms-cli update dockerfile](oms-cli_update_dockerfile.md) - Update FROM statement in Dockerfile with base image from package -* [oms-cli update install-config](oms-cli_update_install-config.md) - Update an existing Codesphere installer configuration -* [oms-cli update oms](oms-cli_update_oms.md) - Update the OMS CLI -* [oms-cli update package](oms-cli_update_package.md) - Download a codesphere package - diff --git a/docs/oms.md b/docs/oms.md new file mode 100644 index 00000000..a47a666a --- /dev/null +++ b/docs/oms.md @@ -0,0 +1,32 @@ +## oms + +Codesphere Operations Management System (OMS) + +### Synopsis + +Codesphere Operations Management System (OMS) + +This command can be used to run common tasks related to managing codesphere installations, +like downloading new versions. + +### Options + +``` + -h, --help help for oms +``` + +### SEE ALSO + +* [oms beta](oms_beta.md) - Commands for early testing +* [oms build](oms_build.md) - Build and push images to a registry +* [oms download](oms_download.md) - Download resources available through OMS +* [oms init](oms_init.md) - Initialize configuration files +* [oms install](oms_install.md) - Install Codesphere and other components +* [oms licenses](oms_licenses.md) - Print license information +* [oms list](oms_list.md) - List resources available through OMS +* [oms register](oms_register.md) - Register a new API key +* [oms revoke](oms_revoke.md) - Revoke resources available through OMS +* [oms smoketest](oms_smoketest.md) - Run smoke tests for Codesphere components +* [oms update](oms_update.md) - Update OMS related resources +* [oms version](oms_version.md) - Print version + diff --git a/docs/oms_beta.md b/docs/oms_beta.md new file mode 100644 index 00000000..a3099355 --- /dev/null +++ b/docs/oms_beta.md @@ -0,0 +1,21 @@ +## oms beta + +Commands for early testing + +### Synopsis + +OMS CLI commands for early adoption and testing. +Be aware that that usage and behavior may change as the features are developed. + +### Options + +``` + -h, --help help for beta +``` + +### SEE ALSO + +* [oms](oms.md) - Codesphere Operations Management System (OMS) +* [oms beta bootstrap-gcp](oms_beta_bootstrap-gcp.md) - Bootstrap GCP infrastructure for Codesphere +* [oms beta extend](oms_beta_extend.md) - Extend Codesphere ressources such as base images. + diff --git a/docs/oms-cli_beta_bootstrap-gcp.md b/docs/oms_beta_bootstrap-gcp.md similarity index 93% rename from docs/oms-cli_beta_bootstrap-gcp.md rename to docs/oms_beta_bootstrap-gcp.md index 47f1b596..d5b333d2 100644 --- a/docs/oms-cli_beta_bootstrap-gcp.md +++ b/docs/oms_beta_bootstrap-gcp.md @@ -1,4 +1,4 @@ -## oms-cli beta bootstrap-gcp +## oms beta bootstrap-gcp Bootstrap GCP infrastructure for Codesphere @@ -11,7 +11,7 @@ Ensure you have the necessary permissions to create and manage GCP resources bef Not for production use. ``` -oms-cli beta bootstrap-gcp [flags] +oms beta bootstrap-gcp [flags] ``` ### Options @@ -55,6 +55,6 @@ oms-cli beta bootstrap-gcp [flags] ### SEE ALSO -* [oms-cli beta](oms-cli_beta.md) - Commands for early testing -* [oms-cli beta bootstrap-gcp postconfig](oms-cli_beta_bootstrap-gcp_postconfig.md) - Run post-configuration steps for GCP bootstrapping +* [oms beta](oms_beta.md) - Commands for early testing +* [oms beta bootstrap-gcp postconfig](oms_beta_bootstrap-gcp_postconfig.md) - Run post-configuration steps for GCP bootstrapping diff --git a/docs/oms-cli_beta_bootstrap-gcp_postconfig.md b/docs/oms_beta_bootstrap-gcp_postconfig.md similarity index 74% rename from docs/oms-cli_beta_bootstrap-gcp_postconfig.md rename to docs/oms_beta_bootstrap-gcp_postconfig.md index d2af9c9e..e4bfa265 100644 --- a/docs/oms-cli_beta_bootstrap-gcp_postconfig.md +++ b/docs/oms_beta_bootstrap-gcp_postconfig.md @@ -1,4 +1,4 @@ -## oms-cli beta bootstrap-gcp postconfig +## oms beta bootstrap-gcp postconfig Run post-configuration steps for GCP bootstrapping @@ -10,7 +10,7 @@ to finalize the setup for the Codesphere cluster on GCP: * Install Google Cloud Controller Manager for ingress management. ``` -oms-cli beta bootstrap-gcp postconfig [flags] +oms beta bootstrap-gcp postconfig [flags] ``` ### Options @@ -23,5 +23,5 @@ oms-cli beta bootstrap-gcp postconfig [flags] ### SEE ALSO -* [oms-cli beta bootstrap-gcp](oms-cli_beta_bootstrap-gcp.md) - Bootstrap GCP infrastructure for Codesphere +* [oms beta bootstrap-gcp](oms_beta_bootstrap-gcp.md) - Bootstrap GCP infrastructure for Codesphere diff --git a/docs/oms-cli_beta_extend.md b/docs/oms_beta_extend.md similarity index 50% rename from docs/oms-cli_beta_extend.md rename to docs/oms_beta_extend.md index 95bc3e63..b4dff5a9 100644 --- a/docs/oms-cli_beta_extend.md +++ b/docs/oms_beta_extend.md @@ -1,4 +1,4 @@ -## oms-cli beta extend +## oms beta extend Extend Codesphere ressources such as base images. @@ -14,6 +14,6 @@ Extend Codesphere ressources such as base images to customize them for your need ### SEE ALSO -* [oms-cli beta](oms-cli_beta.md) - Commands for early testing -* [oms-cli beta extend baseimage](oms-cli_beta_extend_baseimage.md) - Extend Codesphere's workspace base image for customization +* [oms beta](oms_beta.md) - Commands for early testing +* [oms beta extend baseimage](oms_beta_extend_baseimage.md) - Extend Codesphere's workspace base image for customization diff --git a/docs/oms-cli_beta_extend_baseimage.md b/docs/oms_beta_extend_baseimage.md similarity index 84% rename from docs/oms-cli_beta_extend_baseimage.md rename to docs/oms_beta_extend_baseimage.md index 50b8fa19..fb369e7b 100644 --- a/docs/oms-cli_beta_extend_baseimage.md +++ b/docs/oms_beta_extend_baseimage.md @@ -1,4 +1,4 @@ -## oms-cli beta extend baseimage +## oms beta extend baseimage Extend Codesphere's workspace base image for customization @@ -11,7 +11,7 @@ To use the custom base image, you need to push the resulting image to your conta reference it in your install-config for the Codesphere installation process to pick it up and include it in Codesphere ``` -oms-cli beta extend baseimage [flags] +oms beta extend baseimage [flags] ``` ### Options @@ -26,5 +26,5 @@ oms-cli beta extend baseimage [flags] ### SEE ALSO -* [oms-cli beta extend](oms-cli_beta_extend.md) - Extend Codesphere ressources such as base images. +* [oms beta extend](oms_beta_extend.md) - Extend Codesphere ressources such as base images. diff --git a/docs/oms_build.md b/docs/oms_build.md new file mode 100644 index 00000000..f5602bae --- /dev/null +++ b/docs/oms_build.md @@ -0,0 +1,20 @@ +## oms build + +Build and push images to a registry + +### Synopsis + +Build and push container images to a registry using the provided configuration. + +### Options + +``` + -h, --help help for build +``` + +### SEE ALSO + +* [oms](oms.md) - Codesphere Operations Management System (OMS) +* [oms build image](oms_build_image.md) - Build and push Docker image using Dockerfile and Codesphere package version +* [oms build images](oms_build_images.md) - Build and push container images + diff --git a/docs/oms-cli_build_image.md b/docs/oms_build_image.md similarity index 74% rename from docs/oms-cli_build_image.md rename to docs/oms_build_image.md index bc55ea4a..ce746c1d 100644 --- a/docs/oms-cli_build_image.md +++ b/docs/oms_build_image.md @@ -1,4 +1,4 @@ -## oms-cli build image +## oms build image Build and push Docker image using Dockerfile and Codesphere package version @@ -7,14 +7,14 @@ Build and push Docker image using Dockerfile and Codesphere package version Build a Docker image from a Dockerfile and push it to a registry, tagged with the Codesphere version from the package. ``` -oms-cli build image [flags] +oms build image [flags] ``` ### Examples ``` # Build image for Codesphere version 1.68.0 and push to specified registry -$ oms-cli build image --dockerfile baseimage/Dockerfile --package codesphere-v1.68.0.tar.gz --registry my-registry.com/my-image +$ oms build image --dockerfile baseimage/Dockerfile --package codesphere-v1.68.0.tar.gz --registry my-registry.com/my-image ``` @@ -30,5 +30,5 @@ $ oms-cli build image --dockerfile baseimage/Dockerfile --package codesphere-v1. ### SEE ALSO -* [oms-cli build](oms-cli_build.md) - Build and push images to a registry +* [oms build](oms_build.md) - Build and push images to a registry diff --git a/docs/oms-cli_build_images.md b/docs/oms_build_images.md similarity index 77% rename from docs/oms-cli_build_images.md rename to docs/oms_build_images.md index a2f5e409..5a08ee8c 100644 --- a/docs/oms-cli_build_images.md +++ b/docs/oms_build_images.md @@ -1,4 +1,4 @@ -## oms-cli build images +## oms build images Build and push container images @@ -8,7 +8,7 @@ Build and push container images based on the configuration file. Extracts necessary image configurations from the provided install config and the downloaded package. ``` -oms-cli build images [flags] +oms build images [flags] ``` ### Options @@ -21,5 +21,5 @@ oms-cli build images [flags] ### SEE ALSO -* [oms-cli build](oms-cli_build.md) - Build and push images to a registry +* [oms build](oms_build.md) - Build and push images to a registry diff --git a/docs/oms_download.md b/docs/oms_download.md new file mode 100644 index 00000000..388ab6a8 --- /dev/null +++ b/docs/oms_download.md @@ -0,0 +1,21 @@ +## oms download + +Download resources available through OMS + +### Synopsis + +Download resources managed by or available for OMS, +e.g. available Codesphere packages + +### Options + +``` + -h, --help help for download +``` + +### SEE ALSO + +* [oms](oms.md) - Codesphere Operations Management System (OMS) +* [oms download k0s](oms_download_k0s.md) - Download k0s Kubernetes distribution +* [oms download package](oms_download_package.md) - Download a codesphere package + diff --git a/docs/oms-cli_download_k0s.md b/docs/oms_download_k0s.md similarity index 70% rename from docs/oms-cli_download_k0s.md rename to docs/oms_download_k0s.md index 2473948c..b3cbdfc9 100644 --- a/docs/oms-cli_download_k0s.md +++ b/docs/oms_download_k0s.md @@ -1,4 +1,4 @@ -## oms-cli download k0s +## oms download k0s Download k0s Kubernetes distribution @@ -8,23 +8,23 @@ Download a k0s binary directly to the OMS workdir. Will download the latest version if no version is specified. ``` -oms-cli download k0s [flags] +oms download k0s [flags] ``` ### Examples ``` # Download k0s using the Go-native implementation -$ oms-cli download k0s +$ oms download k0s # Download a specific version of k0s -$ oms-cli download k0s --version 1.22.0 +$ oms download k0s --version 1.22.0 # Download k0s with minimal output -$ oms-cli download k0s --quiet +$ oms download k0s --quiet # Force download even if k0s binary exists -$ oms-cli download k0s --force +$ oms download k0s --force ``` @@ -39,5 +39,5 @@ $ oms-cli download k0s --force ### SEE ALSO -* [oms-cli download](oms-cli_download.md) - Download resources available through OMS +* [oms download](oms_download.md) - Download resources available through OMS diff --git a/docs/oms-cli_update_package.md b/docs/oms_download_package.md similarity index 68% rename from docs/oms-cli_update_package.md rename to docs/oms_download_package.md index 583a7e71..6a831ea4 100644 --- a/docs/oms-cli_update_package.md +++ b/docs/oms_download_package.md @@ -1,4 +1,4 @@ -## oms-cli update package +## oms download package Download a codesphere package @@ -8,20 +8,20 @@ Download a specific version of a Codesphere package To list available packages, run oms list packages. ``` -oms-cli update package [VERSION] [flags] +oms download package [VERSION] [flags] ``` ### Examples ``` # Download Codesphere version 1.55.0 -$ oms-cli download package codesphere-v1.55.0 +$ oms download package codesphere-v1.55.0 # Download Codesphere version 1.55.0 -$ oms-cli download package --version codesphere-v1.55.0 +$ oms download package --version codesphere-v1.55.0 # Download lite package of Codesphere version 1.55.0 -$ oms-cli download package --version codesphere-v1.55.0 --file installer-lite.tar.gz +$ oms download package --version codesphere-v1.55.0 --file installer-lite.tar.gz ``` @@ -37,5 +37,5 @@ $ oms-cli download package --version codesphere-v1.55.0 --file installer-lite.ta ### SEE ALSO -* [oms-cli update](oms-cli_update.md) - Update OMS related resources +* [oms download](oms_download.md) - Download resources available through OMS diff --git a/docs/oms_init.md b/docs/oms_init.md new file mode 100644 index 00000000..c249acca --- /dev/null +++ b/docs/oms_init.md @@ -0,0 +1,19 @@ +## oms init + +Initialize configuration files + +### Synopsis + +Initialize configuration files for Codesphere installation and other components. + +### Options + +``` + -h, --help help for init +``` + +### SEE ALSO + +* [oms](oms.md) - Codesphere Operations Management System (OMS) +* [oms init install-config](oms_init_install-config.md) - Initialize Codesphere installer configuration files + diff --git a/docs/oms-cli_init_install-config.md b/docs/oms_init_install-config.md similarity index 87% rename from docs/oms-cli_init_install-config.md rename to docs/oms_init_install-config.md index 52b7c0c7..ece2432a 100644 --- a/docs/oms-cli_init_install-config.md +++ b/docs/oms_init_install-config.md @@ -1,4 +1,4 @@ -## oms-cli init install-config +## oms init install-config Initialize Codesphere installer configuration files @@ -19,23 +19,23 @@ Supports configuration profiles for common scenarios: - minimal: Minimal testing setup ``` -oms-cli init install-config [flags] +oms init install-config [flags] ``` ### Examples ``` # Create config files interactively -$ oms-cli init install-config -c config.yaml --vault prod.vault.yaml +$ oms init install-config -c config.yaml --vault prod.vault.yaml # Use dev profile with defaults -$ oms-cli init install-config --profile dev -c config.yaml --vault prod.vault.yaml +$ oms init install-config --profile dev -c config.yaml --vault prod.vault.yaml # Use production profile -$ oms-cli init install-config --profile production -c config.yaml --vault prod.vault.yaml +$ oms init install-config --profile production -c config.yaml --vault prod.vault.yaml # Validate existing configuration files -$ oms-cli init install-config --validate -c config.yaml --vault prod.vault.yaml +$ oms init install-config --validate -c config.yaml --vault prod.vault.yaml ``` @@ -73,5 +73,5 @@ $ oms-cli init install-config --validate -c config.yaml --vault prod.vault.yaml ### SEE ALSO -* [oms-cli init](oms-cli_init.md) - Initialize configuration files +* [oms init](oms_init.md) - Initialize configuration files diff --git a/docs/oms_install.md b/docs/oms_install.md new file mode 100644 index 00000000..8da4ae02 --- /dev/null +++ b/docs/oms_install.md @@ -0,0 +1,20 @@ +## oms install + +Install Codesphere and other components + +### Synopsis + +Install Codesphere and other components like Ceph and PostgreSQL. + +### Options + +``` + -h, --help help for install +``` + +### SEE ALSO + +* [oms](oms.md) - Codesphere Operations Management System (OMS) +* [oms install codesphere](oms_install_codesphere.md) - Install a Codesphere instance +* [oms install k0s](oms_install_k0s.md) - Install k0s Kubernetes distribution + diff --git a/docs/oms-cli_install_codesphere.md b/docs/oms_install_codesphere.md similarity index 84% rename from docs/oms-cli_install_codesphere.md rename to docs/oms_install_codesphere.md index d99729de..94a693ca 100644 --- a/docs/oms-cli_install_codesphere.md +++ b/docs/oms_install_codesphere.md @@ -1,4 +1,4 @@ -## oms-cli install codesphere +## oms install codesphere Install a Codesphere instance @@ -8,7 +8,7 @@ Install a Codesphere instance with the provided package, configuration file, and Uses the private-cloud-installer.js script included in the package to perform the installation. ``` -oms-cli install codesphere [flags] +oms install codesphere [flags] ``` ### Options @@ -24,5 +24,5 @@ oms-cli install codesphere [flags] ### SEE ALSO -* [oms-cli install](oms-cli_install.md) - Install Codesphere and other components +* [oms install](oms_install.md) - Install Codesphere and other components diff --git a/docs/oms-cli_install_k0s.md b/docs/oms_install_k0s.md similarity index 78% rename from docs/oms-cli_install_k0s.md rename to docs/oms_install_k0s.md index 785e4f88..f4f01eef 100644 --- a/docs/oms-cli_install_k0s.md +++ b/docs/oms_install_k0s.md @@ -1,4 +1,4 @@ -## oms-cli install k0s +## oms install k0s Install k0s Kubernetes distribution @@ -11,26 +11,26 @@ If no version is specified, the latest version will be downloaded. If no install config is provided, k0s will be installed with the '--single' flag. ``` -oms-cli install k0s [flags] +oms install k0s [flags] ``` ### Examples ``` # Install k0s using the Go-native implementation -$ oms-cli install k0s +$ oms install k0s # Version of k0s to install -$ oms-cli install k0s --version +$ oms install k0s --version # Package file (e.g. codesphere-v1.2.3-installer.tar.gz) to load k0s from -$ oms-cli install k0s --package +$ oms install k0s --package # Path to k0s configuration file, if not set k0s will be installed with the '--single' flag -$ oms-cli install k0s --k0s-config +$ oms install k0s --k0s-config # Force new download and installation even if k0s binary exists or is already installed -$ oms-cli install k0s --force +$ oms install k0s --force ``` @@ -46,5 +46,5 @@ $ oms-cli install k0s --force ### SEE ALSO -* [oms-cli install](oms-cli_install.md) - Install Codesphere and other components +* [oms install](oms_install.md) - Install Codesphere and other components diff --git a/docs/oms-cli_licenses.md b/docs/oms_licenses.md similarity index 63% rename from docs/oms-cli_licenses.md rename to docs/oms_licenses.md index d6e1487b..428b8c6d 100644 --- a/docs/oms-cli_licenses.md +++ b/docs/oms_licenses.md @@ -1,4 +1,4 @@ -## oms-cli licenses +## oms licenses Print license information @@ -7,7 +7,7 @@ Print license information Print information about the OMS license and open source licenses of dependencies. ``` -oms-cli licenses [flags] +oms licenses [flags] ``` ### Options @@ -18,5 +18,5 @@ oms-cli licenses [flags] ### SEE ALSO -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) +* [oms](oms.md) - Codesphere Operations Management System (OMS) diff --git a/docs/oms_list.md b/docs/oms_list.md new file mode 100644 index 00000000..a66eb8a1 --- /dev/null +++ b/docs/oms_list.md @@ -0,0 +1,21 @@ +## oms list + +List resources available through OMS + +### Synopsis + +List resources managed by or available for OMS, +eg. available Codesphere packages + +### Options + +``` + -h, --help help for list +``` + +### SEE ALSO + +* [oms](oms.md) - Codesphere Operations Management System (OMS) +* [oms list api-keys](oms_list_api-keys.md) - List API keys +* [oms list packages](oms_list_packages.md) - List available packages + diff --git a/docs/oms-cli_list_api-keys.md b/docs/oms_list_api-keys.md similarity index 54% rename from docs/oms-cli_list_api-keys.md rename to docs/oms_list_api-keys.md index dd7b1c41..d7f2b875 100644 --- a/docs/oms-cli_list_api-keys.md +++ b/docs/oms_list_api-keys.md @@ -1,4 +1,4 @@ -## oms-cli list api-keys +## oms list api-keys List API keys @@ -7,7 +7,7 @@ List API keys List API keys registered in the OMS portal. ``` -oms-cli list api-keys [flags] +oms list api-keys [flags] ``` ### Options @@ -18,5 +18,5 @@ oms-cli list api-keys [flags] ### SEE ALSO -* [oms-cli list](oms-cli_list.md) - List resources available through OMS +* [oms list](oms_list.md) - List resources available through OMS diff --git a/docs/oms-cli_list_packages.md b/docs/oms_list_packages.md similarity index 57% rename from docs/oms-cli_list_packages.md rename to docs/oms_list_packages.md index 1b2ae8bf..b38c8101 100644 --- a/docs/oms-cli_list_packages.md +++ b/docs/oms_list_packages.md @@ -1,4 +1,4 @@ -## oms-cli list packages +## oms list packages List available packages @@ -7,7 +7,7 @@ List available packages List packages available for download via the OMS portal. ``` -oms-cli list packages [flags] +oms list packages [flags] ``` ### Options @@ -18,5 +18,5 @@ oms-cli list packages [flags] ### SEE ALSO -* [oms-cli list](oms-cli_list.md) - List resources available through OMS +* [oms list](oms_list.md) - List resources available through OMS diff --git a/docs/oms-cli_register.md b/docs/oms_register.md similarity index 82% rename from docs/oms-cli_register.md rename to docs/oms_register.md index a2438b90..eeadd5ec 100644 --- a/docs/oms-cli_register.md +++ b/docs/oms_register.md @@ -1,4 +1,4 @@ -## oms-cli register +## oms register Register a new API key @@ -7,7 +7,7 @@ Register a new API key Register a new API key for accessing the OMS portal. ``` -oms-cli register [flags] +oms register [flags] ``` ### Options @@ -22,5 +22,5 @@ oms-cli register [flags] ### SEE ALSO -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) +* [oms](oms.md) - Codesphere Operations Management System (OMS) diff --git a/docs/oms-cli_revoke.md b/docs/oms_revoke.md similarity index 53% rename from docs/oms-cli_revoke.md rename to docs/oms_revoke.md index dcab1d81..f50cd0e4 100644 --- a/docs/oms-cli_revoke.md +++ b/docs/oms_revoke.md @@ -1,4 +1,4 @@ -## oms-cli revoke +## oms revoke Revoke resources available through OMS @@ -15,6 +15,6 @@ eg. api keys. ### SEE ALSO -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -* [oms-cli revoke api-key](oms-cli_revoke_api-key.md) - Revoke an API key +* [oms](oms.md) - Codesphere Operations Management System (OMS) +* [oms revoke api-key](oms_revoke_api-key.md) - Revoke an API key diff --git a/docs/oms-cli_revoke_api-key.md b/docs/oms_revoke_api-key.md similarity index 57% rename from docs/oms-cli_revoke_api-key.md rename to docs/oms_revoke_api-key.md index 45524164..fd0d11d1 100644 --- a/docs/oms-cli_revoke_api-key.md +++ b/docs/oms_revoke_api-key.md @@ -1,4 +1,4 @@ -## oms-cli revoke api-key +## oms revoke api-key Revoke an API key @@ -7,7 +7,7 @@ Revoke an API key Revoke an OMS portal API key. ``` -oms-cli revoke api-key [flags] +oms revoke api-key [flags] ``` ### Options @@ -19,5 +19,5 @@ oms-cli revoke api-key [flags] ### SEE ALSO -* [oms-cli revoke](oms-cli_revoke.md) - Revoke resources available through OMS +* [oms revoke](oms_revoke.md) - Revoke resources available through OMS diff --git a/docs/oms-cli_smoketest.md b/docs/oms_smoketest.md similarity index 50% rename from docs/oms-cli_smoketest.md rename to docs/oms_smoketest.md index 7b2c87d8..48485c96 100644 --- a/docs/oms-cli_smoketest.md +++ b/docs/oms_smoketest.md @@ -1,4 +1,4 @@ -## oms-cli smoketest +## oms smoketest Run smoke tests for Codesphere components @@ -14,6 +14,6 @@ Run automated smoke tests for Codesphere installations to verify functionality. ### SEE ALSO -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) -* [oms-cli smoketest codesphere](oms-cli_smoketest_codesphere.md) - Run smoke tests for a Codesphere installation +* [oms](oms.md) - Codesphere Operations Management System (OMS) +* [oms smoketest codesphere](oms_smoketest_codesphere.md) - Run smoke tests for a Codesphere installation diff --git a/docs/oms-cli_smoketest_codesphere.md b/docs/oms_smoketest_codesphere.md similarity index 60% rename from docs/oms-cli_smoketest_codesphere.md rename to docs/oms_smoketest_codesphere.md index 50eb949b..5cb75578 100644 --- a/docs/oms-cli_smoketest_codesphere.md +++ b/docs/oms_smoketest_codesphere.md @@ -1,4 +1,4 @@ -## oms-cli smoketest codesphere +## oms smoketest codesphere Run smoke tests for a Codesphere installation @@ -9,26 +9,26 @@ setting environment variables, executing commands, syncing landscape, and runnin The workspace is automatically deleted after the test completes. ``` -oms-cli smoketest codesphere [flags] +oms smoketest codesphere [flags] ``` ### Examples ``` # Run smoke tests against a Codesphere installation -$ oms-cli smoketest codesphere --baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID +$ oms smoketest codesphere --baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID # Run smoke tests in quiet mode (no progress logging) -$ oms-cli smoketest codesphere --baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID --quiet +$ oms smoketest codesphere --baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID --quiet # Run smoke tests with custom timeout -$ oms-cli smoketest codesphere --baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID --timeout 15m +$ oms smoketest codesphere --baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID --timeout 15m # Run only specific steps of the smoke test (workspace won't be deleted) -$ oms-cli smoketest codesphere --baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID --steps createWorkspace,syncLandscape +$ oms smoketest codesphere --baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID --steps createWorkspace,syncLandscape # Run specific steps and delete the workspace afterwards -$ oms-cli smoketest codesphere --baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID --steps createWorkspace,syncLandscape,deleteWorkspace +$ oms smoketest codesphere --baseurl https://codesphere.example.com/api --token YOUR_TOKEN --team-id TEAM_ID --plan-id PLAN_ID --steps createWorkspace,syncLandscape,deleteWorkspace ``` @@ -48,5 +48,5 @@ $ oms-cli smoketest codesphere --baseurl https://codesphere.example.com/api --to ### SEE ALSO -* [oms-cli smoketest](oms-cli_smoketest.md) - Run smoke tests for Codesphere components +* [oms smoketest](oms_smoketest.md) - Run smoke tests for Codesphere components diff --git a/docs/oms_update.md b/docs/oms_update.md new file mode 100644 index 00000000..d01aeb6f --- /dev/null +++ b/docs/oms_update.md @@ -0,0 +1,23 @@ +## oms update + +Update OMS related resources + +### Synopsis + +Updates resources, e.g. OMS or OMS API keys. + +### Options + +``` + -h, --help help for update +``` + +### SEE ALSO + +* [oms](oms.md) - Codesphere Operations Management System (OMS) +* [oms update api-key](oms_update_api-key.md) - Update an API key's expiration date +* [oms update dockerfile](oms_update_dockerfile.md) - Update FROM statement in Dockerfile with base image from package +* [oms update install-config](oms_update_install-config.md) - Update an existing Codesphere installer configuration +* [oms update oms](oms_update_oms.md) - Update the OMS CLI +* [oms update package](oms_update_package.md) - Download a codesphere package + diff --git a/docs/oms-cli_update_api-key.md b/docs/oms_update_api-key.md similarity index 75% rename from docs/oms-cli_update_api-key.md rename to docs/oms_update_api-key.md index 4948844a..bb495a66 100644 --- a/docs/oms-cli_update_api-key.md +++ b/docs/oms_update_api-key.md @@ -1,4 +1,4 @@ -## oms-cli update api-key +## oms update api-key Update an API key's expiration date @@ -7,7 +7,7 @@ Update an API key's expiration date Updates the expiration date for a given API key using the --id and --valid-to flags. ``` -oms-cli update api-key [flags] +oms update api-key [flags] ``` ### Options @@ -20,5 +20,5 @@ oms-cli update api-key [flags] ### SEE ALSO -* [oms-cli update](oms-cli_update.md) - Update OMS related resources +* [oms update](oms_update.md) - Update OMS related resources diff --git a/docs/oms-cli_update_dockerfile.md b/docs/oms_update_dockerfile.md similarity index 73% rename from docs/oms-cli_update_dockerfile.md rename to docs/oms_update_dockerfile.md index f127c12b..9baabb06 100644 --- a/docs/oms-cli_update_dockerfile.md +++ b/docs/oms_update_dockerfile.md @@ -1,4 +1,4 @@ -## oms-cli update dockerfile +## oms update dockerfile Update FROM statement in Dockerfile with base image from package @@ -10,17 +10,17 @@ This command extracts the base image from a Codesphere package and updates the F in the specified Dockerfile to use that base image. The base image is loaded into the local Docker daemon so it can be used for building. ``` -oms-cli update dockerfile [flags] +oms update dockerfile [flags] ``` ### Examples ``` # Update Dockerfile to use the default base image from the package (workspace-agent-24.04) -$ oms-cli update dockerfile --dockerfile baseimage/Dockerfile --package codesphere-v1.68.0.tar.gz +$ oms update dockerfile --dockerfile baseimage/Dockerfile --package codesphere-v1.68.0.tar.gz # Update Dockerfile to use the workspace-agent-20.04 base image from the package -$ oms-cli update dockerfile --dockerfile baseimage/Dockerfile --package codesphere-v1.68.0.tar.gz --baseimage workspace-agent-20.04.tar +$ oms update dockerfile --dockerfile baseimage/Dockerfile --package codesphere-v1.68.0.tar.gz --baseimage workspace-agent-20.04.tar ``` @@ -36,5 +36,5 @@ $ oms-cli update dockerfile --dockerfile baseimage/Dockerfile --package codesphe ### SEE ALSO -* [oms-cli update](oms-cli_update.md) - Update OMS related resources +* [oms update](oms_update.md) - Update OMS related resources diff --git a/docs/oms-cli_update_install-config.md b/docs/oms_update_install-config.md similarity index 87% rename from docs/oms-cli_update_install-config.md rename to docs/oms_update_install-config.md index 512eedd2..327591e3 100644 --- a/docs/oms-cli_update_install-config.md +++ b/docs/oms_update_install-config.md @@ -1,4 +1,4 @@ -## oms-cli update install-config +## oms update install-config Update an existing Codesphere installer configuration @@ -15,20 +15,20 @@ For example, updating the PostgreSQL primary IP will trigger regeneration of the PostgreSQL server certificates that include that IP address. ``` -oms-cli update install-config [flags] +oms update install-config [flags] ``` ### Examples ``` # Update PostgreSQL primary IP and regenerate certificates -$ oms-cli update install-config --postgres-primary-ip 10.10.0.4 --config config.yaml --vault prod.vault.yaml +$ oms update install-config --postgres-primary-ip 10.10.0.4 --config config.yaml --vault prod.vault.yaml # Update Codesphere domain -$ oms-cli update install-config --domain new.example.com --config config.yaml --vault prod.vault.yaml +$ oms update install-config --domain new.example.com --config config.yaml --vault prod.vault.yaml # Update Kubernetes API server host -$ oms-cli update install-config --k8s-api-server 10.0.0.10 --config config.yaml --vault prod.vault.yaml +$ oms update install-config --k8s-api-server 10.0.0.10 --config config.yaml --vault prod.vault.yaml ``` @@ -68,5 +68,5 @@ $ oms-cli update install-config --k8s-api-server 10.0.0.10 --config config.yaml ### SEE ALSO -* [oms-cli update](oms-cli_update.md) - Update OMS related resources +* [oms update](oms_update.md) - Update OMS related resources diff --git a/docs/oms-cli_update_oms.md b/docs/oms_update_oms.md similarity index 58% rename from docs/oms-cli_update_oms.md rename to docs/oms_update_oms.md index 1a481d7d..cbbc137e 100644 --- a/docs/oms-cli_update_oms.md +++ b/docs/oms_update_oms.md @@ -1,4 +1,4 @@ -## oms-cli update oms +## oms update oms Update the OMS CLI @@ -7,7 +7,7 @@ Update the OMS CLI Updates the OMS CLI to the latest release from GitHub. ``` -oms-cli update oms [flags] +oms update oms [flags] ``` ### Options @@ -18,5 +18,5 @@ oms-cli update oms [flags] ### SEE ALSO -* [oms-cli update](oms-cli_update.md) - Update OMS related resources +* [oms update](oms_update.md) - Update OMS related resources diff --git a/docs/oms-cli_download_package.md b/docs/oms_update_package.md similarity index 67% rename from docs/oms-cli_download_package.md rename to docs/oms_update_package.md index d0ca18e1..fd7959ed 100644 --- a/docs/oms-cli_download_package.md +++ b/docs/oms_update_package.md @@ -1,4 +1,4 @@ -## oms-cli download package +## oms update package Download a codesphere package @@ -8,20 +8,20 @@ Download a specific version of a Codesphere package To list available packages, run oms list packages. ``` -oms-cli download package [VERSION] [flags] +oms update package [VERSION] [flags] ``` ### Examples ``` # Download Codesphere version 1.55.0 -$ oms-cli download package codesphere-v1.55.0 +$ oms download package codesphere-v1.55.0 # Download Codesphere version 1.55.0 -$ oms-cli download package --version codesphere-v1.55.0 +$ oms download package --version codesphere-v1.55.0 # Download lite package of Codesphere version 1.55.0 -$ oms-cli download package --version codesphere-v1.55.0 --file installer-lite.tar.gz +$ oms download package --version codesphere-v1.55.0 --file installer-lite.tar.gz ``` @@ -37,5 +37,5 @@ $ oms-cli download package --version codesphere-v1.55.0 --file installer-lite.ta ### SEE ALSO -* [oms-cli download](oms-cli_download.md) - Download resources available through OMS +* [oms update](oms_update.md) - Update OMS related resources diff --git a/docs/oms-cli_version.md b/docs/oms_version.md similarity index 54% rename from docs/oms-cli_version.md rename to docs/oms_version.md index 17daf6ef..867f0e83 100644 --- a/docs/oms-cli_version.md +++ b/docs/oms_version.md @@ -1,4 +1,4 @@ -## oms-cli version +## oms version Print version @@ -7,7 +7,7 @@ Print version Print current version of OMS. ``` -oms-cli version [flags] +oms version [flags] ``` ### Options @@ -18,5 +18,5 @@ oms-cli version [flags] ### SEE ALSO -* [oms-cli](oms-cli.md) - Codesphere Operations Management System (OMS) +* [oms](oms.md) - Codesphere Operations Management System (OMS)