Skip to content

Commit da378bb

Browse files
committed
Added fluxctl install docs
1 parent f8a2b4f commit da378bb

File tree

1 file changed

+30
-13
lines changed

1 file changed

+30
-13
lines changed

docs/references/fluxctl.md

+30-13
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,9 @@ Connecting:
196196
# To a fluxd running in namespace "weave" in your current kubectl context
197197
fluxctl --k8s-fwd-ns=weave list-workloads
198198
199+
# To a Weave Cloud instance, with your instance token in $TOKEN
200+
fluxctl --token $TOKEN list-workloads
201+
199202
Workflow:
200203
fluxctl list-workloads # Which workloads are running?
201204
fluxctl list-images --workload=default:deployment/foo # Which images are running/available?
@@ -205,30 +208,44 @@ Usage:
205208
fluxctl [command]
206209
207210
Available Commands:
208-
automate Turn on automatic deployment for a workload.
209-
deautomate Turn off automatic deployment for a workload.
210-
help Help about any command
211-
identity Display SSH public key
212-
list-workloads List workloads currently running in the cluster.
213-
list-images Show the deployed and available images.
214-
lock Lock a workload, so it cannot be deployed.
215-
policy Manage policies for a workload.
216-
release Release a new version of a workload.
217-
save save workload definitions to local files in cluster-native format
218-
sync synchronize the cluster with the git repository, now
219-
unlock Unlock a workload, so it can be deployed.
220-
version Output the version of fluxctl
211+
automate Turn on automatic deployment for a workload.
212+
deautomate Turn off automatic deployment for a workload.
213+
help Help about any command
214+
identity Display SSH public key
215+
install Print and tweak Kubernetes manifests needed to install Flux in a Cluster
216+
list-images Show deployed and available images.
217+
list-workloads List workloads currently running in the cluster.
218+
lock Lock a workload, so it cannot be deployed.
219+
policy Manage policies for a workload.
220+
release Release a new version of a workload.
221+
save save workload definitions to local files in cluster-native format
222+
sync synchronize the cluster with the git repository, now
223+
unlock Unlock a workload, so it can be deployed.
224+
version Output the version of fluxctl
221225
222226
Flags:
223227
-h, --help help for fluxctl
224228
--k8s-fwd-labels stringToString Labels used to select the fluxd pod a port forward should be created for. You can also set the environment variable FLUX_FORWARD_LABELS (default [app=flux])
225229
--k8s-fwd-ns string Namespace in which fluxd is running, for creating a port forward to access the API. No port forward will be created if a URL or token is given. You can also set the environment variable FLUX_FORWARD_NAMESPACE (default "default")
230+
--timeout duration Global command timeout; you can also set the environment variable FLUX_TIMEOUT (default 1m0s)
226231
-t, --token string Weave Cloud authentication token; you can also set the environment variable WEAVE_CLOUD_TOKEN or FLUX_SERVICE_TOKEN
227232
-u, --url string Base URL of the Flux API (defaults to "https://cloud.weave.works/api/flux" if a token is provided); you can also set the environment variable FLUX_URL
228233
229234
Use "fluxctl [command] --help" for more information about a command.
230235
```
231236

237+
### Using `fluxctl install`
238+
239+
Installs Flux into your cluster, taking as input your Git details and namespace you want to target.
240+
241+
Example:
242+
243+
```sh
244+
fluxctl install --git-url 'git@github.com:<your username>/flux-get-started' | kubectl -f -
245+
```
246+
247+
See [here](../tutorials/get-started.html#set-up-flux) for a full tutorial which makes use of `fluxctl install`.
248+
232249
## Workloads
233250

234251
### What is a Workload?

0 commit comments

Comments
 (0)