dsc
The Red Hat OpenShift Dev Spaces (formerly Red Hat OpenShift Dev Spaces) CLI for OpenShift is dsc
.
For OpenShift 4, can also use the OperatorHub installation method:
Report issues
Table Of Contents
Installation
Assemblies of dsc are available at https://github.com/redhat-developer/devspaces-chectl/releases
Manual install:
- Download a .tar.gz file based on your Operating System / Arch
- Unpack the assembly
- move
dsc
folder into a folder like$HOME/dsc
- add
$HOME/dsc/bin
to `$PATH``
Usage
$ dsc server:start
running command...
$ dsc server:stop
running command...
$ dsc workspace:start --devfile
running command...
$ dsc --help [COMMAND]
USAGE
$ dsc COMMAND
...
Commands
dsc autocomplete [SHELL]
dsc cacert:export
dsc dashboard:open
dsc help [COMMAND]
dsc server:debug
dsc server:delete
dsc server:deploy
dsc server:logs
dsc server:start
dsc server:status
dsc server:stop
dsc server:update
dsc update [CHANNEL]
dsc autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ dsc autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ dsc autocomplete
$ dsc autocomplete bash
$ dsc autocomplete zsh
$ dsc autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
dsc cacert:export
Retrieves Red Hat OpenShift Dev Spaces self-signed certificate
USAGE
$ dsc cacert:export
OPTIONS
-d, --destination=destination
Destination where to store Red Hat OpenShift Dev Spaces self-signed CA certificate.
If the destination is a file (might not exist), then the certificate will be saved there in PEM format.
If the destination is a directory, then cheCA.crt file will be created there with Red Hat OpenShift Dev Spaces
certificate in PEM format.
If this option is omitted, then Red Hat OpenShift Dev Spaces certificate will be stored in a user's temporary
directory as cheCA.crt.
-h, --help
show CLI help
-n, --chenamespace=chenamespace
Red Hat OpenShift Dev Spaces Openshift Project.
--telemetry=on|off
Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry
See code: src/commands/cacert/export.ts
dsc dashboard:open
Open Red Hat OpenShift Dev Spaces dashboard
USAGE
$ dsc dashboard:open
OPTIONS
-h, --help show CLI help
-n, --chenamespace=chenamespace Red Hat OpenShift Dev Spaces Openshift Project.
--telemetry=on|off Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry
See code: src/commands/dashboard/open.ts
dsc help [COMMAND]
Display help for dsc.
USAGE
$ dsc help [COMMAND]
ARGUMENTS
COMMAND Command to show help for.
OPTIONS
-n, --nested-commands Include all nested commands in the output.
See code: @oclif/plugin-help
dsc server:debug
Enable local debug of Red Hat OpenShift Dev Spaces server
USAGE
$ dsc server:debug
OPTIONS
-h, --help show CLI help
-n, --chenamespace=chenamespace Red Hat OpenShift Dev Spaces Openshift Project.
--debug-port=debug-port [default: 8000] Red Hat OpenShift Dev Spaces server debug port
--skip-kubernetes-health-check Skip Kubernetes health check
--telemetry=on|off Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry
See code: src/commands/server/debug.ts
dsc server:delete
delete any Red Hat OpenShift Dev Spaces related resource
USAGE
$ dsc server:delete
OPTIONS
-h, --help show CLI help
-n, --chenamespace=chenamespace Red Hat OpenShift Dev Spaces Openshift Project.
-y, --yes Automatic yes to prompts; assume "yes" as answer to all prompts and run
non-interactively
--batch Batch mode. Running a command without end user interaction.
--delete-all Indicates to delete Red Hat OpenShift Dev Spaces and Dev Workspace related resources
--delete-namespace Indicates that a Red Hat OpenShift Dev Spaces namespace will be deleted as well
--skip-kubernetes-health-check Skip Kubernetes health check
--telemetry=on|off Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry
See code: src/commands/server/delete.ts
dsc server:deploy
Deploy Red Hat OpenShift Dev Spaces server
USAGE
$ dsc server:deploy
OPTIONS
-d, --directory=directory
Directory to store logs into
-h, --help
show CLI help
-i, --cheimage=cheimage
Red Hat OpenShift Dev Spaces server container image
-n, --chenamespace=chenamespace
Red Hat OpenShift Dev Spaces Openshift Project.
-p, --platform=openshift|crc
(required) [default: openshift] Type of OpenShift platform. Valid values are "openshift", "crc (for CodeReady
Containers)".
-t, --templates=templates
Path to the templates folder
--[no-]auto-update
Auto update approval strategy for installation Red Hat OpenShift Dev Spaces.
With this strategy will be provided auto-update Red Hat OpenShift Dev Spaces without any human interaction.
By default this flag is enabled.
This parameter is used only when the installer is 'olm'.
--batch
Batch mode. Running a command without end user interaction.
--catalog-source-name=catalog-source-name
OLM catalog source to install Red Hat OpenShift Dev Spaces operator.
This parameter is used only when the installer is the 'olm'.
--catalog-source-namespace=catalog-source-namespace
Namespace for OLM catalog source to install Red Hat OpenShift Dev Spaces operator.
This parameter is used only when the installer is the 'olm'.
--catalog-source-yaml=catalog-source-yaml
Path to a yaml file that describes custom catalog source for installation Red Hat OpenShift Dev Spaces operator.
Catalog source will be applied to the namespace with Red Hat OpenShift Dev Spaces operator.
Also you need define 'olm-channel' name and 'package-manifest-name'.
This parameter is used only when the installer is the 'olm'.
--che-operator-cr-patch-yaml=che-operator-cr-patch-yaml
Path to a yaml file that overrides the default values in CheCluster CR used by the operator. This parameter is used
only when the installer is the 'operator' or the 'olm'.
--che-operator-cr-yaml=che-operator-cr-yaml
Path to a yaml file that defines a CheCluster used by the operator. This parameter is used only when the installer
is the 'operator' or the 'olm'.
--che-operator-image=che-operator-image
Container image of the operator. This parameter is used only when the installer is the operator or OLM.
--debug
'Enables the debug mode for Red Hat OpenShift Dev Spaces server. To debug Red Hat OpenShift Dev Spaces server from
localhost use 'server:debug' command.'
--devfile-registry-url=devfile-registry-url
The URL of the external Devfile registry.
--k8spoddownloadimagetimeout=k8spoddownloadimagetimeout
[default: 1200000] Waiting time for Pod downloading image (in milliseconds)
--k8spoderrorrechecktimeout=k8spoderrorrechecktimeout
[default: 60000] Waiting time for Pod rechecking error (in milliseconds)
--k8spodreadytimeout=k8spodreadytimeout
[default: 60000] Waiting time for Pod Ready condition (in milliseconds)
--k8spodwaittimeout=k8spodwaittimeout
[default: 60000] Waiting time for Pod scheduled condition (in milliseconds)
--olm-channel=olm-channel
Olm channel to install Red Hat OpenShift Dev Spaces, f.e. stable.
If options was not set, will be used default version for package manifest.
This parameter is used only when the installer is the 'olm'.
--package-manifest-name=package-manifest-name
Package manifest name to subscribe to Red Hat OpenShift Dev Spaces OLM package manifest.
This parameter is used only when the installer is the 'olm'.
--plugin-registry-url=plugin-registry-url
The URL of the external plugin registry.
--postgres-pvc-storage-class-name=postgres-pvc-storage-class-name
persistent volume storage class name to use to store Red Hat OpenShift Dev Spaces postgres database
--skip-cert-manager
Skip installing Cert Manager (Kubernetes cluster only).
--skip-devworkspace-operator
Skip installing Dev Workspace Operator (Kubernetes cluster only).
--skip-kubernetes-health-check
Skip Kubernetes health check
--skip-oidc-provider-check
Skip OIDC Provider check
--skip-version-check
Skip minimal versions check.
--starting-csv=starting-csv
Starting cluster service version(CSV) for installation Red Hat OpenShift Dev Spaces.
Flags uses to set up start installation version Che.
For example: 'starting-csv' provided with value 'eclipse-che.v7.10.0' for stable channel.
Then OLM will install Red Hat OpenShift Dev Spaces with version 7.10.0.
Notice: this flag will be ignored with 'auto-update' flag. OLM with auto-update mode installs the latest known
version.
This parameter is used only when the installer is 'olm'.
--telemetry=on|off
Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry
--workspace-pvc-storage-class-name=workspace-pvc-storage-class-name
persistent volume(s) storage class name to use to store Red Hat OpenShift Dev Spaces workspaces data
See code: src/commands/server/deploy.ts
dsc server:logs
Collect Red Hat OpenShift Dev Spaces logs
USAGE
$ dsc server:logs
OPTIONS
-d, --directory=directory Directory to store logs into
-h, --help show CLI help
-n, --chenamespace=chenamespace Red Hat OpenShift Dev Spaces Openshift Project.
--skip-kubernetes-health-check Skip Kubernetes health check
--telemetry=on|off Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry
See code: src/commands/server/logs.ts
dsc server:start
Start Red Hat OpenShift Dev Spaces server
USAGE
$ dsc server:start
OPTIONS
-d, --directory=directory Directory to store logs into
-h, --help show CLI help
-n, --chenamespace=chenamespace Red Hat OpenShift Dev Spaces Openshift Project.
--batch Batch mode. Running a command without end user interaction.
--k8spoddownloadimagetimeout=k8spoddownloadimagetimeout [default: 1200000] Waiting time for Pod downloading image (in
milliseconds)
--k8spoderrorrechecktimeout=k8spoderrorrechecktimeout [default: 60000] Waiting time for Pod rechecking error (in
milliseconds)
--k8spodreadytimeout=k8spodreadytimeout [default: 60000] Waiting time for Pod Ready condition (in
milliseconds)
--k8spodwaittimeout=k8spodwaittimeout [default: 60000] Waiting time for Pod scheduled condition (in
milliseconds)
--skip-kubernetes-health-check Skip Kubernetes health check
--telemetry=on|off Enable or disable telemetry. This flag skips a prompt and
enable/disable telemetry
See code: src/commands/server/start.ts
dsc server:status
Status Red Hat OpenShift Dev Spaces server
USAGE
$ dsc server:status
OPTIONS
-h, --help show CLI help
-n, --chenamespace=chenamespace Red Hat OpenShift Dev Spaces Openshift Project.
--telemetry=on|off Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry
See code: src/commands/server/status.ts
dsc server:stop
stop Red Hat OpenShift Dev Spaces server
USAGE
$ dsc server:stop
OPTIONS
-h, --help show CLI help
-n, --chenamespace=chenamespace Red Hat OpenShift Dev Spaces Openshift Project.
--skip-kubernetes-health-check Skip Kubernetes health check
--telemetry=on|off Enable or disable telemetry. This flag skips a prompt and enable/disable telemetry
See code: src/commands/server/stop.ts
dsc server:update
Update Red Hat OpenShift Dev Spaces server.
USAGE
$ dsc server:update
OPTIONS
-h, --help show CLI help
-n, --chenamespace=chenamespace Red Hat OpenShift Dev Spaces Openshift Project.
-t, --templates=templates Path to the templates folder
-y, --yes Automatic yes to prompts; assume "yes" as answer to all
prompts and run non-interactively
--batch Batch mode. Running a command without end user interaction.
--che-operator-cr-patch-yaml=che-operator-cr-patch-yaml Path to a yaml file that overrides the default values in
CheCluster CR used by the operator. This parameter is used
only when the installer is the 'operator' or the 'olm'.
--che-operator-image=che-operator-image Container image of the operator. This parameter is used only
when the installer is the operator or OLM.
--skip-devworkspace-operator Skip installing Dev Workspace Operator (Kubernetes cluster
only).
--skip-kubernetes-health-check Skip Kubernetes health check
--skip-version-check Skip minimal versions check.
--telemetry=on|off Enable or disable telemetry. This flag skips a prompt and
enable/disable telemetry
EXAMPLES
# Update Red Hat OpenShift Dev Spaces:
dsc server:update
# Update Red Hat OpenShift Dev Spaces in 'eclipse-che' namespace:
dsc server:update -n eclipse-che
# Update Red Hat OpenShift Dev Spaces and update its configuration in the custom resource:
dsc server:update --che-operator-cr-patch-yaml patch.yaml
See code: src/commands/server/update.ts
dsc update [CHANNEL]
update the dsc CLI
USAGE
$ dsc update [CHANNEL]
OPTIONS
--from-local interactively choose an already installed version
See code: @oclif/plugin-update
Contributing
Contributing to dsc is covered in CONTRIBUTING.md