docs: liqoctl commands reference

Author: claudiolor

.github/workflows/lint.yml

@@ -95,7 +95,7 @@ jobs:
       with:
         config: '.markdownlint.yml'
         args: '**/*.md'
-        ignore: .github/ISSUE_TEMPLATE/*.md
+        ignore: ".github/ISSUE_TEMPLATE/*.md docs/usage/liqoctl/*.md"
 
   doclint:
     name: Lint documentation files
@@ -123,7 +123,7 @@ jobs:
       working-directory: ./docs
       run: |
         make linkcheck
-        
+
   helmlint:
     name: Lint helm chart
     runs-on: ubuntu-latest

docs/Makefile

@@ -31,4 +31,4 @@ autoserve: install
 	@$(SPHINXAUTOBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXAUTOOPTS) --port 8081 $(O)
 
 lint:
-	markdownlint lint -c ../.markdownlint.yml **/*.md
+	markdownlint lint -c ../.markdownlint.yml -i usage/liqoctl **/*.md

docs/_toc.yml

@@ -35,6 +35,9 @@ subtrees:
       - file: usage/stateful-applications.md
       - file: usage/prometheus-metrics.md
       - file: usage/service-continuity.md
+      - file: usage/liqoctl-commands.md
+        entries:
+          - glob: usage/liqoctl/*
 
   - caption: Advanced usage
     entries:

docs/usage/liqoctl-commands.md

@@ -0,0 +1,8 @@
+# liqoctl commands
+
+In the previous sections we have seen how to use the `liqoctl` CLI to install and configuring peering connection with Liqo.
+This section contains all the available `liqoctl` commands.
+
+```{admonition} Note
+Note that you can get the same info when working with any of the `liqoctl` commands, by providing the `--help` flag to it.
+```

docs/usage/liqoctl/liqoctl.md

@@ -0,0 +1,21 @@
+# liqoctl
+
+A CLI tool to install and manage Liqo
+
+## Description
+
+### Synopsis
+
+liqoctl is a CLI tool to install and manage Liqo.
+
+Liqo is a platform to enable dynamic and decentralized resource sharing across
+Kubernetes clusters, either on-prem or managed. Liqo allows to run pods on a
+remote cluster seamlessly and without any modification of Kubernetes and the
+applications. With Liqo it is possible to extend the control and data plane of a
+Kubernetes cluster across the cluster's boundaries, making multi-cluster native
+and transparent: collapse an entire remote cluster to a local virtual node,
+enabling workloads offloading, resource management and cross-cluster communication
+compliant with the standard Kubernetes approach.
+
+
+

docs/usage/liqoctl/liqoctl_activate.md

@@ -0,0 +1,79 @@
+# liqoctl activate
+
+Activate a liqo resource
+
+## Description
+
+### Synopsis
+
+Activate a liqo resource
+
+
+## liqoctl activate tenant
+
+Activate a tenant cluster
+
+### Synopsis
+
+Activate a tenant cluster.
+
+This command allows to activate a tenant cluster, allowing it to receive new resources.
+Resources provided by existing ResourceSlices are provided again.
+
+
+
+```
+liqoctl activate tenant [flags]
+```
+
+### Examples
+
+
+```bash
+  $ liqoctl activate tenant my-tenant-name
+```
+
+
+
+
+
+### Options
+`--cluster` _string_:
+
+>The name of the kubeconfig cluster to use
+
+`--context` _string_:
+
+>The name of the kubeconfig context to use
+
+`--kubeconfig` _string_:
+
+>Path to the kubeconfig file to use for CLI requests
+
+`--timeout` _duration_:
+
+>Timeout for activate completion **(default 2m0s)**
+
+`--user` _string_:
+
+>The name of the kubeconfig user to use
+
+`-v`, `--verbose`
+
+>Enable verbose logs (default false)
+
+
+### Global options
+
+`--global-annotations` _stringToString_:
+
+>Global annotations to be added to all created resources (key=value)
+
+`--global-labels` _stringToString_:
+
+>Global labels to be added to all created resources (key=value)
+
+`--skip-confirm`
+
+>Skip the confirmation prompt (suggested for automation)
+

docs/usage/liqoctl/liqoctl_authenticate.md

@@ -0,0 +1,104 @@
+# liqoctl authenticate
+
+Authenticate with a provider cluster
+
+## Description
+
+### Synopsis
+
+Authenticate with a provider cluster.
+
+This command allows a consumer cluster to communicate with a remote provider cluster
+to obtain slices of resources from. At the end of the process, the consumer cluster will
+be able to replicate ResourceSlices resources to the provider cluster, and to receive
+an associated Identity to consume the provided resources.
+
+
+
+```
+liqoctl authenticate [flags]
+```
+
+### Examples
+
+
+```bash
+  $ liqoctl authenticate --remote-kubeconfig <provider>
+```
+
+
+
+
+
+### Options
+`--cluster` _string_:
+
+>The name of the kubeconfig cluster to use
+
+`--context` _string_:
+
+>The name of the kubeconfig context to use
+
+`--in-band`
+
+>Use in-band authentication. Use it only if required and if you know what you are doing
+
+`--kubeconfig` _string_:
+
+>Path to the kubeconfig file to use for CLI requests
+
+`-n`, `--namespace` _string_:
+
+>The namespace where Liqo is installed in **(default "liqo")**
+
+`--proxy-url` _string_:
+
+>The URL of the proxy to use for the communication with the remote cluster
+
+`--remote-cluster` _string_:
+
+>The name of the kubeconfig cluster to use (in the remote cluster)
+
+`--remote-context` _string_:
+
+>The name of the kubeconfig context to use (in the remote cluster)
+
+`--remote-kubeconfig` _string_:
+
+>Path to the kubeconfig file to use for CLI requests (in the remote cluster)
+
+`--remote-namespace` _string_:
+
+>The namespace where Liqo is installed in (in the remote cluster) **(default "liqo")**
+
+`--remote-user` _string_:
+
+>The name of the kubeconfig user to use (in the remote cluster)
+
+`--timeout` _duration_:
+
+>Timeout for completion **(default 2m0s)**
+
+`--user` _string_:
+
+>The name of the kubeconfig user to use
+
+`-v`, `--verbose`
+
+>Enable verbose logs (default false)
+
+
+### Global options
+
+`--global-annotations` _stringToString_:
+
+>Global annotations to be added to all created resources (key=value)
+
+`--global-labels` _stringToString_:
+
+>Global labels to be added to all created resources (key=value)
+
+`--skip-confirm`
+
+>Skip the confirmation prompt (suggested for automation)
+