Skip to content

update(docs): Add examples for install codesphere command #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NautiluX merged 2 commits into from
Mar 23, 2026
Merged

update(docs): Add examples for install codesphere command #257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e4c5eee
update(docs): Add examples for install codesphere command
NautiluX Mar 23, 2026
b24d564
chore(docs): Auto-update docs and licenses
NautiluX Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions NOTICE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,9 @@ License URL: https://github.com/cloudflare/circl/blob/v1.6.3/LICENSE

----------
Module: github.com/codesphere-cloud/cs-go
Version: v0.21.1
Version: v0.22.0
License: Apache-2.0
License URL: https://github.com/codesphere-cloud/cs-go/blob/v0.21.1/LICENSE
License URL: https://github.com/codesphere-cloud/cs-go/blob/v0.22.0/LICENSE

----------
Module: github.com/codesphere-cloud/oms/internal/tmpl
Expand Down Expand Up @@ -227,9 +227,9 @@ License URL: https://github.com/extism/go-sdk/blob/v1.7.1/LICENSE

----------
Module: github.com/fatih/color
Version: v1.18.0
Version: v1.19.0
License: MIT
License URL: https://github.com/fatih/color/blob/v1.18.0/LICENSE.md
License URL: https://github.com/fatih/color/blob/v1.19.0/LICENSE.md

----------
Module: github.com/felixge/httpsnoop
Expand Down Expand Up @@ -797,9 +797,9 @@ License URL: https://github.com/open-telemetry/opentelemetry-proto-go/blob/otlp/

----------
Module: go.yaml.in/yaml/v2
Version: v2.4.3
Version: v2.4.4
License: Apache-2.0
License URL: https://github.com/yaml/go-yaml/blob/v2.4.3/LICENSE
License URL: https://github.com/yaml/go-yaml/blob/v2.4.4/LICENSE

----------
Module: go.yaml.in/yaml/v3
Expand Down Expand Up @@ -929,9 +929,9 @@ License URL: https://github.com/helm/helm/blob/v4.1.3/LICENSE

----------
Module: k8s.io/api
Version: v0.35.2
Version: v0.35.3
License: Apache-2.0
License URL: https://github.com/kubernetes/api/blob/v0.35.2/LICENSE
License URL: https://github.com/kubernetes/api/blob/v0.35.3/LICENSE

----------
Module: k8s.io/apiextensions-apiserver/pkg/apis/apiextensions
Expand All @@ -941,15 +941,15 @@ License URL: https://github.com/kubernetes/apiextensions-apiserver/blob/v0.35.1/

----------
Module: k8s.io/apimachinery/pkg
Version: v0.35.2
Version: v0.35.3
License: Apache-2.0
License URL: https://github.com/kubernetes/apimachinery/blob/v0.35.2/LICENSE
License URL: https://github.com/kubernetes/apimachinery/blob/v0.35.3/LICENSE

----------
Module: k8s.io/apimachinery/third_party/forked/golang
Version: v0.35.2
Version: v0.35.3
License: BSD-3-Clause
License URL: https://github.com/kubernetes/apimachinery/blob/v0.35.2/third_party/forked/golang/LICENSE
License URL: https://github.com/kubernetes/apimachinery/blob/v0.35.3/third_party/forked/golang/LICENSE

----------
Module: k8s.io/apiserver/pkg/endpoints/deprecation
Expand All @@ -959,21 +959,21 @@ License URL: https://github.com/kubernetes/apiserver/blob/v0.35.1/LICENSE

----------
Module: k8s.io/cli-runtime/pkg
Version: v0.35.2
Version: v0.35.3
License: Apache-2.0
License URL: https://github.com/kubernetes/cli-runtime/blob/v0.35.2/LICENSE
License URL: https://github.com/kubernetes/cli-runtime/blob/v0.35.3/LICENSE

----------
Module: k8s.io/client-go
Version: v0.35.2
Version: v0.35.3
License: Apache-2.0
License URL: https://github.com/kubernetes/client-go/blob/v0.35.2/LICENSE
License URL: https://github.com/kubernetes/client-go/blob/v0.35.3/LICENSE

----------
Module: k8s.io/client-go/third_party/forked/golang/template
Version: v0.35.2
Version: v0.35.3
License: BSD-3-Clause
License URL: https://github.com/kubernetes/client-go/blob/v0.35.2/third_party/forked/golang/LICENSE
License URL: https://github.com/kubernetes/client-go/blob/v0.35.3/third_party/forked/golang/LICENSE

----------
Module: k8s.io/component-base/version
Expand Down
10 changes: 10 additions & 0 deletions cli/cmd/install_codesphere.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,16 @@ func AddInstallCodesphereCmd(install *cobra.Command, opts *GlobalOptions) {
Short: "Install a Codesphere instance",
Long: io.Long(`Install a Codesphere instance with the provided package, configuration file, and private key.
Uses the private-cloud-installer.js script included in the package to perform the installation.`),
Example: formatExamples("install codesphere", []io.Example{
{
Cmd: "-p codesphere-v1.2.3-installer-lite.tar.gz -k <path-to-private-key> -c config.yaml -s copy-dependencies,extract-dependencies,load-container-images,ceph,postgres,kubernetes,docker",
Desc: "Skip most pre-installation steps. E.g. if you only need to re-apply Codesphere's helm charts",
},
{
Cmd: "-p codesphere-v1.2.3-installer-lite.tar.gz -k <path-to-private-key> -c config.yaml -s load-container-images",
Desc: "Skip loading container images. Necessary when installing a lite package that doesn't include any container images",
},
}),
},
Opts: &InstallCodesphereOpts{GlobalOptions: opts},
Env: env.NewEnv(),
Expand Down
11 changes: 11 additions & 0 deletions docs/oms_install_codesphere.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,17 @@ Uses the private-cloud-installer.js script included in the package to perform th
oms install codesphere [flags]
```

### Examples

```
# Skip most pre-installation steps. E.g. if you only need to re-apply Codesphere's helm charts
$ oms install codesphere -p codesphere-v1.2.3-installer-lite.tar.gz -k <path-to-private-key> -c config.yaml -s copy-dependencies,extract-dependencies,load-container-images,ceph,postgres,kubernetes,docker

# Skip loading container images. Necessary when installing a lite package that doesn't include any container images
$ oms install codesphere -p codesphere-v1.2.3-installer-lite.tar.gz -k <path-to-private-key> -c config.yaml -s load-container-images

```

### Options

```
Expand Down
36 changes: 18 additions & 18 deletions internal/tmpl/NOTICE
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,9 @@ License URL: https://github.com/cloudflare/circl/blob/v1.6.3/LICENSE

----------
Module: github.com/codesphere-cloud/cs-go
Version: v0.21.1
Version: v0.22.0
License: Apache-2.0
License URL: https://github.com/codesphere-cloud/cs-go/blob/v0.21.1/LICENSE
License URL: https://github.com/codesphere-cloud/cs-go/blob/v0.22.0/LICENSE

----------
Module: github.com/codesphere-cloud/oms/internal/tmpl
Expand Down Expand Up @@ -227,9 +227,9 @@ License URL: https://github.com/extism/go-sdk/blob/v1.7.1/LICENSE

----------
Module: github.com/fatih/color
Version: v1.18.0
Version: v1.19.0
License: MIT
License URL: https://github.com/fatih/color/blob/v1.18.0/LICENSE.md
License URL: https://github.com/fatih/color/blob/v1.19.0/LICENSE.md

----------
Module: github.com/felixge/httpsnoop
Expand Down Expand Up @@ -797,9 +797,9 @@ License URL: https://github.com/open-telemetry/opentelemetry-proto-go/blob/otlp/

----------
Module: go.yaml.in/yaml/v2
Version: v2.4.3
Version: v2.4.4
License: Apache-2.0
License URL: https://github.com/yaml/go-yaml/blob/v2.4.3/LICENSE
License URL: https://github.com/yaml/go-yaml/blob/v2.4.4/LICENSE

----------
Module: go.yaml.in/yaml/v3
Expand Down Expand Up @@ -929,9 +929,9 @@ License URL: https://github.com/helm/helm/blob/v4.1.3/LICENSE

----------
Module: k8s.io/api
Version: v0.35.2
Version: v0.35.3
License: Apache-2.0
License URL: https://github.com/kubernetes/api/blob/v0.35.2/LICENSE
License URL: https://github.com/kubernetes/api/blob/v0.35.3/LICENSE

----------
Module: k8s.io/apiextensions-apiserver/pkg/apis/apiextensions
Expand All @@ -941,15 +941,15 @@ License URL: https://github.com/kubernetes/apiextensions-apiserver/blob/v0.35.1/

----------
Module: k8s.io/apimachinery/pkg
Version: v0.35.2
Version: v0.35.3
License: Apache-2.0
License URL: https://github.com/kubernetes/apimachinery/blob/v0.35.2/LICENSE
License URL: https://github.com/kubernetes/apimachinery/blob/v0.35.3/LICENSE

----------
Module: k8s.io/apimachinery/third_party/forked/golang
Version: v0.35.2
Version: v0.35.3
License: BSD-3-Clause
License URL: https://github.com/kubernetes/apimachinery/blob/v0.35.2/third_party/forked/golang/LICENSE
License URL: https://github.com/kubernetes/apimachinery/blob/v0.35.3/third_party/forked/golang/LICENSE

----------
Module: k8s.io/apiserver/pkg/endpoints/deprecation
Expand All @@ -959,21 +959,21 @@ License URL: https://github.com/kubernetes/apiserver/blob/v0.35.1/LICENSE

----------
Module: k8s.io/cli-runtime/pkg
Version: v0.35.2
Version: v0.35.3
License: Apache-2.0
License URL: https://github.com/kubernetes/cli-runtime/blob/v0.35.2/LICENSE
License URL: https://github.com/kubernetes/cli-runtime/blob/v0.35.3/LICENSE

----------
Module: k8s.io/client-go
Version: v0.35.2
Version: v0.35.3
License: Apache-2.0
License URL: https://github.com/kubernetes/client-go/blob/v0.35.2/LICENSE
License URL: https://github.com/kubernetes/client-go/blob/v0.35.3/LICENSE

----------
Module: k8s.io/client-go/third_party/forked/golang/template
Version: v0.35.2
Version: v0.35.3
License: BSD-3-Clause
License URL: https://github.com/kubernetes/client-go/blob/v0.35.2/third_party/forked/golang/LICENSE
License URL: https://github.com/kubernetes/client-go/blob/v0.35.3/third_party/forked/golang/LICENSE

----------
Module: k8s.io/component-base/version
Expand Down
Loading