This is an automated email from the ASF dual-hosted git repository.
msciabarra pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/openserverless-task.git
The following commit(s) were added to refs/heads/main by this push:
new a2c4e67 refreshing update-cli
a2c4e67 is described below
commit a2c4e6745edbbe3a4b75a7d960b91a87042d7223
Author: Michele Sciabarra <[email protected]>
AuthorDate: Sun Aug 11 16:16:50 2024 +0200
refreshing update-cli
---
config/docopts.md | 15 ++++++++-------
setup/docopts.md | 23 +++++++++++++----------
util/docopts.txt | 42 +++++++++++++++++++++---------------------
util/opsfile.yml | 7 -------
4 files changed, 42 insertions(+), 45 deletions(-)
diff --git a/config/docopts.md b/config/docopts.md
index 1361146..4c84082 100644
--- a/config/docopts.md
+++ b/config/docopts.md
@@ -1,10 +1,11 @@
-# Tasks:
+# Tasks `ops config`
- `ops config`
+Configure OpenServerless
-# Usage:
+## Synopsis
-```Usage:
+```text
+Usage:
config (enable|disable) [--all] [--redis] [--mongodb] [--minio] [--cron]
[--static] [--postgres] [--prometheus] [--slack] [--mail] [--affinity]
[--tolerations] [--quota]
config apihost (<apihost>|auto) [--tls=<email>]
[--protocol=<http/https>|auto]
config runtimes [<runtimesjson>]
@@ -27,7 +28,7 @@
config minimal
```
-# Commands:
+## Commands:
```
config apihost configure the apihost (auto: auto assign) and enable
tls
config runtime show the current runtime.json or import the
<runtime-json> if provided
@@ -53,7 +54,7 @@
config minimal shortcut for ops config enabling only
redis,mongodb,minio,cron,static,postgres
```
-# Options:
+## Options:
```
--all select all services
--redis select redis
@@ -84,4 +85,4 @@
--s3 activate s3 compatible ingress on components
supporting it
--console activate a s3console ingress on components supporting
it (Currently MINIO)
--quota select quota checker module
-```
\ No newline at end of file
+```
diff --git a/setup/docopts.md b/setup/docopts.md
index 87c6894..09b0e0a 100644
--- a/setup/docopts.md
+++ b/setup/docopts.md
@@ -1,8 +1,11 @@
-# Section:
- ops ent setup
+# Tasks `ops setup`
-# Usage:
-```
+Manage installation
+
+## Synopsis
+
+```text
+Usage:
setup devcluster [--uninstall|--status]
setup cluster [<context>] [--uninstall|--status]
setup server <server> [<user>] [--uninstall|--status]
@@ -11,7 +14,7 @@
setup prereq
```
-# Commands:
+## Commands:
```
setup cluster deploy Apache OpenServerless in the Kubernetes cluster
using the <context>, default the current
setup devcluster deploy Apache OpenServerless in a devcluster created
locally
@@ -23,13 +26,13 @@
setup prereq validate current configuration
```
-# Options:
+## Options:
```
--uninstall execute an uninstall instead of an installation
--status show the status instead of an installation
```
-# Subcommands:
-```
- kubernetes kubernetes subcommands
-```
\ No newline at end of file
+## Subtasks
+
+- `kubernetes`: prepare kubernetes
+- `nuvolaris`: install nuvolaris
diff --git a/util/docopts.txt b/util/docopts.txt
index cbcf538..0d2f2cf 100644
--- a/util/docopts.txt
+++ b/util/docopts.txt
@@ -1,29 +1,29 @@
-Section: ops util
+# Task: ops util
+## Synopsis
+
+```text
Usage:
+ util system
+ util update-cli
+ util check-operator-version <version>
util secrets
util nosecrets
util user-secrets <username>
util no-user-secrets <username>
- util detect
- util poll
- util realpath <file>
util kubectl <args>...
util kubeconfig
- util check-operator-version <version>
-
-Commands:
- secrets generate system secrets
- nosecrets remove system secrets
- user-secrets generate user secrets for the given user
- no-user-secrets remove user secrets for the given user
- detect detect the current kubernetes cluster
- poll run wsk poll
- realpath return full path of specified file
- kubectl execute kubectl on current kubeconfig
- kubeconfig export OVERWRITING current kubeconfig to
~/.kube/config
- notify notify installation
- install-notify-receiver as described
- 1password 1password support
- check-operator-version as described
-
\ No newline at end of file
+```
+# Commands:
+
+```
+- system system info (<os>-<arch> in Go format)
+- update-cli update the cli downloading the binary
+- check-operator-version check if you need to update the operator
+- secrets generate system secrets
+- nosecrets remove system secrets
+- user-secrets generate user secrets for the given user
+- no-user-secrets remove user secrets for the given user
+- kubectl execute kubectl on current kubeconfig
+- kubeconfig export OVERWRITING current kubeconfig to
~/.kube/config
+```
\ No newline at end of file
diff --git a/util/opsfile.yml b/util/opsfile.yml
index 7a45f55..57d780a 100644
--- a/util/opsfile.yml
+++ b/util/opsfile.yml
@@ -104,13 +104,6 @@ tasks:
config -r "${USR}_SECRET_POSTGRES"
echo "Removed ${USR} user secrets."
- poll:
- desc: wsk poll
- cmds:
- - wsk activation poll
-
- realpath:
- - realpath {{._file_}}
kubectl:
silent: true
