Skip to content

Commit a3941fa

Browse files
author
Simon Emms
committed
[installer]: document the commands naming convention and usage
1 parent b0b8664 commit a3941fa

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

install/installer/cmd/README.md

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Cmd
2+
3+
Publicly available commands are part of our user contract. They use [Cobra](https://cobra.dev/) to build the Golang CLI commands.
4+
5+
## Commands
6+
7+
### config
8+
9+
These are designed to manipulate configuration files and generate a configuration file that can be used to install Gitpod.
10+
11+
#### init
12+
13+
> This replaces `init`, which is now deprecated
14+
15+
This should be run first. This will generate a new `gitpod.config.yaml` file with the default values configured.
16+
17+
#### build-from-envvars
18+
19+
This builds the config from environment variables.
20+
21+
#### cluster
22+
23+
Cluster commands are designed to deploy a Kubernetes resource to the cluster and generate the config value based upon the result. Typically (although not exclusively), these will be Jobs.
24+
25+
##### shiftfs
26+
27+
Detects whether ShiftFS is supported on the cluster for building images. If not, this will default to Fuse.
28+
29+
#### files
30+
31+
Files commands are designed to be run against the file structure. They may be run directly on the node, or by mounting the file system as a volume in a pod.
32+
33+
##### containerd
34+
35+
Detects the containerd settings for a cluster. This will return the location of the containerd socket and the path to the directory.

0 commit comments

Comments
 (0)