Skip to content

Commit 8dee057

Browse files
author
Adrian Kosmaczewski
committed
Added suggestion by Simon Gerber
1 parent 4e37fa1 commit 8dee057

1 file changed

Lines changed: 5 additions & 19 deletions

File tree

docs/modules/ROOT/pages/index.adoc

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -178,31 +178,17 @@ $ mkdir -p commodore
178178
$ cd commodore
179179
----
180180

181-
=== Compiling the Commodore Catalog
181+
==== Preparing the working directory
182182

183-
The first step to create a Commodore Component is what is usually referred to as "compiling the catalog." This catalog provides a unique reference point of information about all the configuration and workloads affecting a single cluster.
183+
The easiest way to prepare a working directory for Commodore is to compile a cluster catalog. This operation will create all the directories which Commodore expects to be present when creating a new component. The following command will compile the catalog for one of the clusters which we've created previously.
184184

185185
[source,bash]
186186
----
187-
$ kubectl --context minikube -n lieutenant get cluster
188-
NAME DISPLAY NAME TENANT AGE
189-
c-aged-cloud-4988 Kind cluster t-weathered-fire-7929 3m58s
190-
c-late-cloud-248 K3s cluster t-weathered-fire-7929 8m24s
191-
c-solitary-voice-5640 Minikube cluster t-weathered-fire-7929 10m
192-
193-
$ commodore catalog compile c-aged-cloud-4988
194-
...
195-
196-
$ commodore catalog compile c-late-cloud-248
197-
...
198-
199-
$ commodore catalog compile c-solitary-voice-5640
200-
...
187+
$ CLUSTER_ID=$(kubectl --context minikube -n lieutenant get cluster --no-headers -o custom-columns="NAME:.metadata.name" | head -n1)
188+
$ commodore catalog compile ${CLUSTER_ID}
201189
----
202190

203-
We must repeat this operation for each cluster, and of course, you should use the cluster IDs you got from the last `kubectl` command above.
204-
205-
TIP: You can use the `commodore_compile_all` command instead!
191+
We don't have to repeat this operation for each cluster. But if you wanted, you can use the `commodore_compile_all` command instead. This command was created when you `source commodore_command.sh` previously.
206192

207193
=== Creating a New Commodore Component
208194

0 commit comments

Comments
 (0)