This is an automated email from the ASF dual-hosted git repository.
franztt pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/openserverless-site.git
The following commit(s) were added to refs/heads/main by this push:
new 382463b chore: advanced reference (#45)
382463b is described below
commit 382463b2c3f0906b8e13e418d71aebe870b10c3a
Author: Bruno Salzano <[email protected]>
AuthorDate: Fri Nov 1 08:02:22 2024 +0100
chore: advanced reference (#45)
Reviewed all the Advanced Reference. Updated tasks.
Fixed link on right sidebar
---
Taskfile.yaml | 11 +++--
.../reference/references/actions-new/_index.md | 23 +++++++++--
.../reference/references/advanced-cli/_index.md | 2 +-
.../reference/references/naming-limits/_index.md | 4 +-
.../docs/reference/references/rest_api/_index.md | 6 +--
content/en/docs/reference/tasks/_index.md | 18 ++++++---
content/en/docs/reference/tasks/admin/_index.md | 31 ++++++++++++++
content/en/docs/reference/tasks/cloud/_index.md | 21 ++++++++++
.../en/docs/reference/tasks/cloud/aks/_index.md | 28 +++++++++++++
.../en/docs/reference/tasks/cloud/aws/_index.md | 33 +++++++++++++++
.../docs/reference/tasks/cloud/azcloud/_index.md | 34 ++++++++++++++++
.../en/docs/reference/tasks/cloud/eks/_index.md | 28 +++++++++++++
.../en/docs/reference/tasks/cloud/gcloud/_index.md | 23 +++++++++++
.../en/docs/reference/tasks/cloud/gke/_index.md | 25 ++++++++++++
.../en/docs/reference/tasks/cloud/k3s/_index.md | 25 ++++++++++++
.../en/docs/reference/tasks/cloud/mk8s/_index.md | 25 ++++++++++++
.../en/docs/reference/tasks/cloud/osh/_index.md | 13 ++++++
content/en/docs/reference/tasks/config/_index.md | 30 ++++++++------
content/en/docs/reference/tasks/debug/_index.md | 40 ++++++++++++++++++
content/en/docs/reference/tasks/ide/_index.md | 39 ++++++++++++++++++
content/en/docs/reference/tasks/setup/_index.md | 20 ++++++---
content/en/docs/reference/tasks/util/_index.md | 47 ++++++++++++++++++++++
content/en/docs/reference/tools/base64/_index.md | 6 +--
content/en/docs/reference/tools/datefmt/_index.md | 10 ++---
.../en/docs/reference/tools/needupdate/_index.md | 2 +-
content/en/docs/reference/tools/sh/_index.md | 2 +-
content/en/docs/reference/tools/validate/_index.md | 19 ++++++++-
hugo.yaml | 2 +-
28 files changed, 517 insertions(+), 50 deletions(-)
diff --git a/Taskfile.yaml b/Taskfile.yaml
index 99e050f..6f96619 100644
--- a/Taskfile.yaml
+++ b/Taskfile.yaml
@@ -20,7 +20,7 @@ tasks:
# cat $file >> content/en/docs/reference/tools/$name/_index.md
done
- cp tools.md content/en/docs/reference/tools/_index.md
- #- rm -rf openserverless-cli
+ - rm -rf openserverless-cli
import-task:
desc: import task documentation
@@ -34,11 +34,14 @@ tasks:
echo "> Converting ${file} to ${tgt}"
mkdir -p "content/en/docs/reference/tasks/$(dirname $tgt)"
name="$(basename $(dirname "Tasks"/$tgt))"
- echo -e "---\ntitle: ${name}\n---\n"
>content/en/docs/reference/tasks/$tgt
- sed '/^# /d' "$file" >>content/en/docs/reference/tasks/$tgt
+ description=$(awk '/^# /{flag=1; next} /^## /{flag=0} flag && NF'
"$file")
+ description=$(echo "$description" | tr -d '\n' | tr -d '\r' | xargs)
+ remaining=$(awk '/^## /{flag=1} flag' "$file")
+ echo -e "---\ntitle: ${name^}\ndescription: ${description}\n---\n"
>content/en/docs/reference/tasks/$tgt
+ echo -e "$remaining" >>content/en/docs/reference/tasks/$tgt
#cat $file >>content/en/docs/reference/tasks/$tgt
done
- #- rm -rf openserverless-task
+ - rm -rf openserverless-task
preview:
desc: preview the websites
diff --git a/content/en/docs/reference/references/actions-new/_index.md
b/content/en/docs/reference/references/actions-new/_index.md
index 290664f..68e23ca 100644
--- a/content/en/docs/reference/references/actions-new/_index.md
+++ b/content/en/docs/reference/references/actions-new/_index.md
@@ -8,27 +8,28 @@ draft: false
## Adding Action Language Runtimes
OpenWhisk and OpenServerless supports [several languages and
-runtimes](#index-runtimes.adoc) but there may be other languages or
+runtimes](/docs/reference/runtimes) but there may be other languages or
runtimes that are important for your organization, and for which you
want tighter integration with the platform.
The platform is extensible and you can add new languages or runtimes
(with custom packages and third-party dependencies)
+{{< blockquote info >}}
This guide describes the contract a runtime must satisfy. However all
the OpenServerless runtimes are implemented the [using the ActionLoop
-Proxy](#actions-actionloop.adoc). This proxy is implemented in Go,
+Proxy](/docs/reference/references/actions-actionloop). This proxy is
implemented in Go,
already satifies the semantic of a runtime ands makes very easy to build
a new runtime. You just need to provide "launcher code" in your favorite
programming language and a compilation script (generally written in
python) for the initialization of an action. You are advised to use it
for your own runtimes and use the material of this document as reference
for the behaviour of a runtime.
+{{< /blockquote >}}
### Runtime general requirements
-The unit of execution for all functions is a [Docker
-container](https://docs.docker.com) which must implement a specific
+The unit of execution for all functions is a [Docker
container](https://docs.docker.com) which must implement a specific
[Action interface](##action-interface) that, in general performs:
1. **[Initialization](##initialization)** - accepts an initialization
@@ -79,6 +80,8 @@ structure defines the Docker image name that is used for
actions of this
kind (e.g., `openwhisk/nodejs10action:latest` for the JSON example
above).
+## The test action
+
The standard test action is shown below in JavaScript. It should be
adapted for the new language and added to the [test artifacts
directory](../tests/dat/actions/unicode.tests) with the name
@@ -94,6 +97,8 @@ with a `-`. For example, a plain text function for
`nodejs:20` becomes
return { "winter": str };
}
+## Action Interface
+
An action consists of the user function (and its dependencies) along
with a *proxy* that implements a canonical protocol to integrate with
the OpenWhisk and OpenServerless platform.
@@ -109,6 +114,8 @@ The proxy is a web server with two endpoints.
The proxy also prepares the execution context, and flushes the logs
produced by the function to stdout and stderr.
+### Initialization
+
The initialization route is `/init`. It must accept a `POST` request
with a JSON object as follows:
@@ -188,6 +195,8 @@ that even if the context is available during
initialization, it must be
reset with every new activation since the information will change with
every execution.
+### Activation
+
The proxy is ready to execute a function once it has successfully
completed initialization. The OpenWhisk and OpenServerless platform will
invoke the function by posting an HTTP request to `/run` with a JSON
@@ -259,6 +268,8 @@ time limit (e.g., 60 seconds). The activation must complete
within the
allowed duration. Failure to complete activation within the allowed time
frame will destroy the container.
+### Logging
+
The proxy must flush all the logs produced during initialization and
execution and add a frame marker to denote the end of the log stream for
an activation. This is done by emitting the token
@@ -266,6 +277,10 @@ an activation. This is done by emitting the token
`stdout` *and* `stderr` streams. Failure to emit this marker will cause
delayed or truncated activation logs.
+## Testing
+
+### Action Interface tests
+
The [Action interface](##action-interface) is enforced via a canonical
test suite which validates the initialization protocol, the runtime
protocol, ensures the activation context is correctly prepared, and that
diff --git a/content/en/docs/reference/references/advanced-cli/_index.md
b/content/en/docs/reference/references/advanced-cli/_index.md
index ad7f24d..ed319e6 100644
--- a/content/en/docs/reference/references/advanced-cli/_index.md
+++ b/content/en/docs/reference/references/advanced-cli/_index.md
@@ -26,7 +26,7 @@ There are two required properties to configure:
2. **Authorization key** (username and password) which grants you
access to the OpenWhisk and OpenServerless API.
-The API host ia the installationj host, the one you configure in
+The API host is the installation host, the one you configure in
installation with `ops config apihost`
ops -wsk property set --apihost <openwhisk_baseurl>
diff --git a/content/en/docs/reference/references/naming-limits/_index.md
b/content/en/docs/reference/references/naming-limits/_index.md
index d21209f..c2471f7 100644
--- a/content/en/docs/reference/references/naming-limits/_index.md
+++ b/content/en/docs/reference/references/naming-limits/_index.md
@@ -20,7 +20,7 @@ package, so package nesting is not allowed. Also, entities do
not have
to be contained in a package.
In OpenServerless a namespace corresponds to an user. You can create users
-with the [admin subcommand](#cli:admin.adoc) of the CLI.
+with the [admin subcommand](/docs/cli/admin/) of the CLI.
The fully qualified name of an entity is
`/namespaceName[/packageName]/entityName`. Notice that `/` is used to
@@ -110,7 +110,7 @@ OpenWhisk and OpenServerless has a few system limits,
including how much
memory an action can use and how many action invocations are allowed per
minute.
-**Note:** On Openwhisk 2.0 with the scheduler service, **concurrent** in
+**Note:** On Openwhisk 2.0 with the scheduler service, _**concurrent**_ in
the table below really means the max containers that can be provisioned
at once for a namespace. The api *may* be able to accept more
activations than this number at once depending on a number of factors.
diff --git a/content/en/docs/reference/references/rest_api/_index.md
b/content/en/docs/reference/references/rest_api/_index.md
index d11ac9e..0355a4d 100644
--- a/content/en/docs/reference/references/rest_api/_index.md
+++ b/content/en/docs/reference/references/rest_api/_index.md
@@ -51,7 +51,7 @@ support POST requests, which are used to invoke actions and
triggers and
enable or disable rules.
All APIs are protected with HTTP Basic authentication. You can use the
-[nuvadmin](../tools/admin/nuvadmin) tool to generate a new namespace and
+[ops admin](/docs/reference/tasks/admin) tool to generate a new namespace and
authentication. The Basic authentication credentials are in the `AUTH`
property in your `~/.nuvprops` file, delimited by a colon. You can also
retrieve these credentials using the CLI running
@@ -93,7 +93,7 @@ allowed (that is, Access-Control-Allow-Methods is
**Attention:** Because OpenWhisk and OpenServerless currently supports only
one key per namespace, it is not recommended to use CORS beyond simple
-experiments. Use [Web Actions](#webactions.adoc) to expose your actions
+experiments. Use [Web Actions](/docs/reference/entities/webactions) to expose
your actions
to the public and not use the OpenWhisk and OpenServerless authorization key
for client applications that require CORS.
@@ -210,7 +210,7 @@ You get the following response:
### Annotations and Web Actions
To create an action as a web action, you need to add an
-[annotation](#annotations.adoc) of `web-export=true` for web actions.
+[annotation](/docs/reference/entities/annotations) of `web-export=true` for
web actions.
Since web-actions are publicly accessible, you should protect
pre-defined parameters (i.e., treat them as final) using the annotation
`final=true`. If you create or update an action using the CLI flag
diff --git a/content/en/docs/reference/tasks/_index.md
b/content/en/docs/reference/tasks/_index.md
index cadf238..efe7e00 100644
--- a/content/en/docs/reference/tasks/_index.md
+++ b/content/en/docs/reference/tasks/_index.md
@@ -1,20 +1,26 @@
---
title: Tasks
+description: Type `ops <task>` to see usage and subtasks.
---
+## OpenServerless Administration Tasks
-Type `ops <task>` to see usage and subtasks.
-
-## OpenServerless Tasks:
-
-```
+```text
+ admin Manage additional users in OpenServerless
config Manage the Apache OpenServerless configuration
setup Setup the Apache OpenServerless platform on multiple environments
debug Debug utilities for the Apache OpenServerless platform
+ cloud OpenServerless setup utilities for supported Deployment models
on Cloud Providers
util Utilities
```
-## OpenWhisk Tasks:
+## OpenServerless Development Tasks
+
+```text
+ ide OpenServerless Development Utilities
+```
+
+## OpenWhisk Tasks
```text
action Manage actions
diff --git a/content/en/docs/reference/tasks/admin/_index.md
b/content/en/docs/reference/tasks/admin/_index.md
new file mode 100644
index 0000000..78aea36
--- /dev/null
+++ b/content/en/docs/reference/tasks/admin/_index.md
@@ -0,0 +1,31 @@
+---
+title: Admin
+description: Administer OpenServerless users.
+---
+
+## Synopsis
+
+In OpenServerless, users are namespaces.
+You can create namespaces and choose which services to enable.
+
+```text
+Usage:
+ admin adduser <username> <email> <password> [--all] [--redis] [--mongodb]
[--minio] [--postgres] [--storagequota=<quota>|auto]
+ admin deleteuser <username>
+```
+
+## Commands
+```
+ admin adduser create a new user in OpenServerless with the username,
email and password provided
+ admin deleteuser delete a user from the OpenServerless installation via
the username provided
+```
+
+## Options
+```
+ --all enable all services
+ --redis enable redis
+ --mongodb enable mongodb
+ --minio enable minio
+ --postgres enable postgres
+ --storagequota=<quota>
+```
diff --git a/content/en/docs/reference/tasks/cloud/_index.md
b/content/en/docs/reference/tasks/cloud/_index.md
new file mode 100644
index 0000000..40251e1
--- /dev/null
+++ b/content/en/docs/reference/tasks/cloud/_index.md
@@ -0,0 +1,21 @@
+---
+title: Cloud
+description: Administer cloud and baremetal infrastructure
+---
+
+## OpenServerless Cloud Administration Tasks
+
+Administer deploy of various kubernetes cluster on different cloud providers
+or virtual machines or bare metal.
+
+```text
+aks Azure AKS subcommands
+aws Amazon Web Services subcommands
+azcloud Azure Cloud subcommands
+eks Amazon Web Services - EKS subcommands
+gcloud Google Cloud subcommands
+gke Google Cloud - GKE subcommands
+k3s Rancher K3S subcommands
+mk8s Ubuntu MicroK8s subcommands
+osh RedHat OpenShift subcommands
+```
diff --git a/content/en/docs/reference/tasks/cloud/aks/_index.md
b/content/en/docs/reference/tasks/cloud/aks/_index.md
new file mode 100644
index 0000000..3900000
--- /dev/null
+++ b/content/en/docs/reference/tasks/cloud/aks/_index.md
@@ -0,0 +1,28 @@
+---
+title: Aks
+description: Create and Manage an Azure AKS cluster
+---
+
+## Synopsis
+
+```text
+Usage:
+ aks config
+ aks create
+ aks delete
+ aks kubeconfig
+ aks lb
+ aks status
+```
+
+## Commands
+
+```
+ config configure an Azure AKS kubernetes cluster
+ create create an Azure AKS kubernetes cluster
+ delete delete the current Azure AKS cluster
+ kubeconfig extract the kubeconfig to access
+ lb show the load balancer
+ prereq check prerequisites
+ status show the cluster status
+```
diff --git a/content/en/docs/reference/tasks/cloud/aws/_index.md
b/content/en/docs/reference/tasks/cloud/aws/_index.md
new file mode 100644
index 0000000..8d48af4
--- /dev/null
+++ b/content/en/docs/reference/tasks/cloud/aws/_index.md
@@ -0,0 +1,33 @@
+---
+title: Aws
+description: Create and Manage an Amazon Virtual Machines and Dns Zones
+---
+
+## Synopsis
+
+```text
+Usage:
+ aws vm-list
+ aws vm-create <name>
+ aws vm-delete <name>
+ aws vm-getip <name>
+ aws zone-create <zone>
+ aws zone-delete <zone>
+ aws zone-list [<zone>]
+ aws zone-update <zone> (--host=<host>|--wildcard)
(--vm=<vm>|--ip=<ip>|--cname=<cname>)
+```
+
+## Commands
+
+```
+Commands:
+ vm-list lists the vm and their ips
+ vm-create create a vm
+ vm-getip get ip
+ vm-delete delete the vm
+ zone-create create a zone - you will have to delegate the zone
+ from the parent zone assigning the nameservers
+ zone-delete delete a zone
+ zone-list list zones
+ zone-update update a zone with an ip, a cname or the ip of a vm
+```
diff --git a/content/en/docs/reference/tasks/cloud/azcloud/_index.md
b/content/en/docs/reference/tasks/cloud/azcloud/_index.md
new file mode 100644
index 0000000..96ce4b1
--- /dev/null
+++ b/content/en/docs/reference/tasks/cloud/azcloud/_index.md
@@ -0,0 +1,34 @@
+---
+title: Azcloud
+description: Manage Azure Virtual Machines and DNS Zones
+---
+
+## Synopsis
+
+```text
+Usage:
+ azcloud vm-list
+ azcloud vm-ip <name>
+ azcloud vm-create <name>
+ azcloud vm-delete <name>
+ azcloud vm-getip <name>
+ azcloud zone-create <zone>
+ azcloud zone-delete <zone>
+ azcloud zone-list [<zone>]
+ azcloud zone-update <zone> (--host=<host>|--wildcard)
(--vm=<vm>|--ip=<ip>|--cname=<cname>)
+```
+
+## Commands
+
+```
+ vm-ip create public ip
+ vm-list lists the vm and their ips
+ vm-create create a vm
+ vm-getip get ip
+ vm-delete delete the vm
+ zone-create create a zone - you will have to delegate the zone
+ from the parent zone assigning the nameservers
+ zone-delete delete a zone
+ zone-list list zones
+ zone-update update a zone with an ip, a cname or the ip of a vm
+```
diff --git a/content/en/docs/reference/tasks/cloud/eks/_index.md
b/content/en/docs/reference/tasks/cloud/eks/_index.md
new file mode 100644
index 0000000..f071790
--- /dev/null
+++ b/content/en/docs/reference/tasks/cloud/eks/_index.md
@@ -0,0 +1,28 @@
+---
+title: Eks
+description: Create and Manage an Amazon EKS cluster
+---
+
+## Synopsis
+
+```text
+Usage:
+ eks config
+ eks create
+ eks delete
+ eks kubeconfig
+ eks lb
+ eks status
+```
+
+## Commands
+
+```
+ config configure an Amazon EKS cluster
+ create create an Amazon EKS cluster
+ delete delete the current Amazon EKS cluster
+ kubeconfig extract kubeconfig for connecting to the cluster
+ lb show the load balancer hostname
+ prereq check prerequisites
+ status show the cluster status
+```
diff --git a/content/en/docs/reference/tasks/cloud/gcloud/_index.md
b/content/en/docs/reference/tasks/cloud/gcloud/_index.md
new file mode 100644
index 0000000..ad20f17
--- /dev/null
+++ b/content/en/docs/reference/tasks/cloud/gcloud/_index.md
@@ -0,0 +1,23 @@
+---
+title: Gcloud
+description: Create and Manage Google Virtual Machines
+---
+
+## Synopsis
+
+```text
+Usage:
+ gcloud vm-list
+ gcloud vm-create <name>
+ gcloud vm-delete <name>
+ gcloud vm-getip <name>
+```
+
+## Commands
+
+```
+ vm-list lists the vm and their ips
+ vm-create create a vm
+ vm-getip get ip
+ vm-delete delete the vm
+```
diff --git a/content/en/docs/reference/tasks/cloud/gke/_index.md
b/content/en/docs/reference/tasks/cloud/gke/_index.md
new file mode 100644
index 0000000..d5f11e3
--- /dev/null
+++ b/content/en/docs/reference/tasks/cloud/gke/_index.md
@@ -0,0 +1,25 @@
+---
+title: Gke
+description: Create and Manage Google Kubernetes Engine cluster
+---
+
+## Synopsis
+
+```text
+Usage:
+ gke config
+ gke create
+ gke delete
+ gke kubeconfig
+ gke lb
+```
+
+## Commands
+
+```
+ config configure a Google Kubernetes Engine cluster
+ create create a Google Kubernetes Engine cluster
+ delete delete aks cluster
+ kubeconfig extract kubeconfig to access
+ lb show the load balancer
+```
diff --git a/content/en/docs/reference/tasks/cloud/k3s/_index.md
b/content/en/docs/reference/tasks/cloud/k3s/_index.md
new file mode 100644
index 0000000..6072f5b
--- /dev/null
+++ b/content/en/docs/reference/tasks/cloud/k3s/_index.md
@@ -0,0 +1,25 @@
+---
+title: K3s
+description: Create and Manage K3S cluster
+---
+
+## Synopsis
+
+```text
+Usage:
+ k3s create <server> [<user>]
+ k3s delete <server> [<user>]
+ k3s info
+ k3s kubeconfig <server> [<user>]
+ k3s status
+```
+
+## Commands
+
+```
+ create create a k3s with ssh in <server> using <user> with sudo
+ delete uninstall k3s with ssh in <server> using <username> with sudo
+ info info on the server
+ kubeconfig recover the kubeconfig from a k3s server <server> with user
<username>
+ status status of the server
+```
diff --git a/content/en/docs/reference/tasks/cloud/mk8s/_index.md
b/content/en/docs/reference/tasks/cloud/mk8s/_index.md
new file mode 100644
index 0000000..d35152b
--- /dev/null
+++ b/content/en/docs/reference/tasks/cloud/mk8s/_index.md
@@ -0,0 +1,25 @@
+---
+title: Mk8s
+description: Create and Manage an mk8s kubernetes cluster
+---
+
+## Synopsis
+
+```text
+Usage:
+ mk8s create <server> [<user>]
+ mk8s delete <server> [<user>]
+ mk8s info
+ mk8s kubeconfig <server> [<user>]
+ mk8s status
+```
+
+## Commands
+
+```
+ create create a mk8s with ssh in <server> using <user> with sudo
+ delete uninstall microk8s with ssh in <server> using <user> with sudo
+ info info on the server
+ kubeconfig recover the kubeconfig from a server <server> with microk8s
+ status status of the server
+```
diff --git a/content/en/docs/reference/tasks/cloud/osh/_index.md
b/content/en/docs/reference/tasks/cloud/osh/_index.md
new file mode 100644
index 0000000..7cf74d0
--- /dev/null
+++ b/content/en/docs/reference/tasks/cloud/osh/_index.md
@@ -0,0 +1,13 @@
+---
+title: Osh
+description: OpenShift configuration
+---
+
+## Synopsis
+
+```text
+Usage:
+ osh import <kubeconfig>
+ osh test <kubeconfig>
+ osh setup
+```
diff --git a/content/en/docs/reference/tasks/config/_index.md
b/content/en/docs/reference/tasks/config/_index.md
index 5ea6745..3454b86 100644
--- a/content/en/docs/reference/tasks/config/_index.md
+++ b/content/en/docs/reference/tasks/config/_index.md
@@ -1,12 +1,12 @@
---
-title: config
+title: Config
+description: Configure OpenServerless
---
+## Synopsis
- `ops config`
-
-
-```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>]
@@ -20,15 +20,18 @@ title: config
config postgres [--failover] [--backup] [--schedule=<cron_expression>]
[--replicas=<replicas>]
config minio [--s3] [--console]
config aws [--access=<access>] [--secret=<secret>] [--region=<region>]
[--image=<image>] [--vm=<vm>] [--vmuser=<vmuser>] [--disk=<disk>] [--key=<key>]
- config eks [--access=<access>] [--secret=<secret>] [--region=<region>]
[--name=<name>] [--count=<count>] [--vm=<vm>] [--disk=<disk>] [--key=<key>]
[--kubever=<kubever>]
+ config eks [--project=<project>] [--access=<access>] [--secret=<secret>]
[--region=<region>] [--name=<name>] [--count=<count>] [--vm=<vm>]
[--disk=<disk>] [--key=<key>] [--kubever=<kubever>]
config gcloud [--project=<project>] [--region=<region>] [--vm=<vm>]
[--disk=<disk>] [--key=<key>] [--image=<image>]
config gke [--name=<name>] [--project=<project>] [--region=<region>]
[--count=<count>] [--vm=<vm>] [--disk=<disk>]
- config aks [--name=<name>] [--region=<region>] [--count=<count>]
[--vm=<vm>] [--disk=<disk>] [--key=<key>]
+ config azcloud [--project=<project>] [--region=<region>] [--vm=<vm>]
[--disk=<disk>] [--key=<key>] [--image=<image>]
+ config aks [--project=<project>] [--name=<name>] [--region=<region>]
[--count=<count>] [--vm=<vm>] [--disk=<disk>] [--key=<key>]
config (status|export|reset)
config use [<n>] [--delete] [--rename=<rename>]
config minimal
```
+## 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
@@ -45,8 +48,9 @@ title: config
config aws configure Amazon Web Service (AWS) credentials and
parameters
config gcloud configure Google Cloud credentials and parameters
config eks configure Amazon EKS Kubernetes Cluster
- config aks configure Azure AKS Kubernetest Cluster
- config gke configure Google Cloud GKE Kubernetest Cluster
+ config azcloud configure Azure VM credentials and parameters
+ config aks configure Azure AKS Kubernetes Cluster
+ config gke configure Google Cloud GKE Kubernetes Cluster
config reset reset configuration
config status show current configuration
config export export all the variables
@@ -54,6 +58,8 @@ title: config
config minimal shortcut for ops config enabling only
redis,mongodb,minio,cron,static,postgres
```
+## Options
+
```
--all select all services
--redis select redis
@@ -75,13 +81,13 @@ title: config
--delete delete the selected kubeconfig
--image=<image> specify gcp image type (default to
ubuntu-minimal-2204-lts. Passing ubuntu-minimal-2204-lts-arm64 will create ARM
based VM)
--prometheus select monitoring via Prometheus
- --slack select alert manager module over slack channel
+ --slack select alert manager module over Slack channel
--mail select alert manager module over mail channel using a
gmail account
--affinity select pod affinity for multinode enterprise
deployment. In such case load will be splitted between node labeled with
nuvolaris-role in core or invoker
--tolerations select pod tolerations for multinode enterprise
deployment.
--failover select failover support on components supporting it as
postgres
--backup select automatic backup on components support it as
postgres
--s3 activate s3 compatible ingress on components
supporting it
- --console activate a s3console ingress on components supporting
it (Currently MINIO)
+ --console activate a s3 console ingress on components supporting
it (Currently MINIO)
--quota select quota checker module
-```
\ No newline at end of file
+```
diff --git a/content/en/docs/reference/tasks/debug/_index.md
b/content/en/docs/reference/tasks/debug/_index.md
new file mode 100644
index 0000000..899aaaa
--- /dev/null
+++ b/content/en/docs/reference/tasks/debug/_index.md
@@ -0,0 +1,40 @@
+---
+title: Debug
+description: Debugging various parts of OpenServerless
+---
+
+## Synopsis
+```text
+Usage:
+ debug apihost
+ debug certs
+ debug config
+ debug images
+ debug ingress
+ debug kube
+ debug lb
+ debug log
+ debug route
+ debug runtimes
+ debug status
+ debug watch
+ debug operator:version
+```
+
+## Commands
+
+```text
+ apihost show current apihost
+ certs show certificates
+ config show deployed configuration
+ images show current images
+ ingress show ingresses
+ kube kubernetes support subcommand prefix
+ lb show ingress load balancer
+ log show logs
+ route show openshift route
+ runtimes show runtimes
+ status show deployment status
+ watch watch nodes and pod deployment
+ operator:version show operator versions
+```
diff --git a/content/en/docs/reference/tasks/ide/_index.md
b/content/en/docs/reference/tasks/ide/_index.md
new file mode 100644
index 0000000..5d0b37a
--- /dev/null
+++ b/content/en/docs/reference/tasks/ide/_index.md
@@ -0,0 +1,39 @@
+---
+title: Ide
+description: OpenServerless Development Utilities.
+---
+
+## Synopsis
+
+```text
+Usage:
+ ide login [<username>] [<apihost>]
+ ide devel [--dry-run]
+ ide deploy [<action>] [--dry-run]
+ ide undeploy [<action>] [--dry-run]
+ ide clean
+ ide setup
+ ide serve
+ ide poll
+ ide shell
+ ide kill
+ ide python
+ ide nodejs
+```
+
+## Commands
+
+```
+ ide login login in openserverless
+ ide devel activate development mode
+ ide deploy deploy everything or just one action
+ ide undeploy undeploy everything or just one action
+ ide clean clean the temporay files
+ ide setup setup the ide
+ ide serve serve web area
+ ide kill kill current devel or deploy job
+ ide poll poll for logs
+ ide shell start a shell with current env
+ ide python python subcommands
+ ide nodejs nodejs subcommands
+```
diff --git a/content/en/docs/reference/tasks/setup/_index.md
b/content/en/docs/reference/tasks/setup/_index.md
index 1ac6b14..676c9cc 100644
--- a/content/en/docs/reference/tasks/setup/_index.md
+++ b/content/en/docs/reference/tasks/setup/_index.md
@@ -1,10 +1,12 @@
---
-title: setup
+title: Setup
+description: Manage installation
---
- ops ent setup
+## Synopsis
-```
+```text
+Usage:
setup devcluster [--uninstall|--status]
setup cluster [<context>] [--uninstall|--status]
setup server <server> [<user>] [--uninstall|--status]
@@ -13,6 +15,8 @@ title: setup
setup prereq
```
+## 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
@@ -24,11 +28,15 @@ title: setup
setup prereq validate current configuration
```
+## Options
+
```
--uninstall execute an uninstall instead of an installation
--status show the status instead of an installation
```
-```
- kubernetes kubernetes subcommands
-```
\ No newline at end of file
+## Subtasks
+
+- `kubernetes`: prepare kubernetes
+- `nuvolaris`: install nuvolaris
+- `docker`: prepare docker
diff --git a/content/en/docs/reference/tasks/util/_index.md
b/content/en/docs/reference/tasks/util/_index.md
new file mode 100644
index 0000000..e3fe9cd
--- /dev/null
+++ b/content/en/docs/reference/tasks/util/_index.md
@@ -0,0 +1,47 @@
+---
+title: Util
+description: OpenServerless Utilities
+---
+
+## 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 kubectl <args>...
+ util kubeconfig
+ util config <configjson> [--override] [--showhelp]
+ util upload <folder> [--batchsize=<batchsize>] [--verbose] [--clean]
+```
+
+## 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
+- config update configuration file interactively
+- upload uploads a folder to the web bucket in
OpenServerless.
+```
+
+## Options
+
+```
+ --showhelp Show configuration tool help.
+ --override Override the current configuration.
+ --verbose Provide more details.
+ --clean Remove all files from the web bucket before upload.
+ --batchsize=<batchsize> Number of concurrent web uploads
+```
diff --git a/content/en/docs/reference/tools/base64/_index.md
b/content/en/docs/reference/tools/base64/_index.md
index 84c4c0a..f2c4bc7 100644
--- a/content/en/docs/reference/tools/base64/_index.md
+++ b/content/en/docs/reference/tools/base64/_index.md
@@ -14,9 +14,9 @@ Usage:
## Options
```
- -h, --help Display this help message
- -e, --encode <string> Encode a string to base64
- -d, --decode <string> Decode a base64 string
+-h, --help Display this help message
+-e, --encode <string> Encode a string to base64
+-d, --decode <string> Decode a base64 string
```
## Examples
diff --git a/content/en/docs/reference/tools/datefmt/_index.md
b/content/en/docs/reference/tools/datefmt/_index.md
index ecdc7f1..4944712 100644
--- a/content/en/docs/reference/tools/datefmt/_index.md
+++ b/content/en/docs/reference/tools/datefmt/_index.md
@@ -12,11 +12,11 @@ Usage:
## Options
```
- -h, --help print this help info
- -t, --timestamp unix timestamp to format (default: current time)
- -s, --str date string to format
- --if input format to use with input date string
(via --str)
- -f, --of output format to use (default: UnixDate)
+-h, --help print this help info
+-t, --timestamp unix timestamp to format (default: current time)
+-s, --str date string to format
+--if input format to use with input date string (via --str)
+-f, --of output format to use (default: UnixDate)
```
Possible formats (they follows the standard naming of go time formats, with
the addition of 'Millisecond' and 'ms'):
diff --git a/content/en/docs/reference/tools/needupdate/_index.md
b/content/en/docs/reference/tools/needupdate/_index.md
index 45c4747..a409477 100644
--- a/content/en/docs/reference/tools/needupdate/_index.md
+++ b/content/en/docs/reference/tools/needupdate/_index.md
@@ -13,7 +13,7 @@ Usage:
## Options
```
- -h, --help print this help info
+-h, --help print this help info
```
## Examples
diff --git a/content/en/docs/reference/tools/sh/_index.md
b/content/en/docs/reference/tools/sh/_index.md
index 21bd03e..f95c780 100644
--- a/content/en/docs/reference/tools/sh/_index.md
+++ b/content/en/docs/reference/tools/sh/_index.md
@@ -8,7 +8,7 @@ Without args, starts an interactive shell. Otherwise execute
the script specifie
```text
Usage:
- ops sh [<script>|-h|--help]
+ ops -sh [<script>|-h|--help]
```
diff --git a/content/en/docs/reference/tools/validate/_index.md
b/content/en/docs/reference/tools/validate/_index.md
index 1de4252..a73de79 100644
--- a/content/en/docs/reference/tools/validate/_index.md
+++ b/content/en/docs/reference/tools/validate/_index.md
@@ -10,7 +10,7 @@ Usage:
ops -validate [-e] [-m | -n | -r <regex>] <value> [<message>]
```
-## Options:
+## Options
```
-e Retrieve value from the environment variable with the given name.
@@ -19,3 +19,20 @@ ops -validate [-e] [-m | -n | -r <regex>] <value> [<message>]
-n Check if the value is a number.
-r string Check if the value matches the given regular expression.
```
+
+## Examples
+
+### Validate with regexp
+
+### Validate email
+
+```
+ops -validate -m [email protected]
+```
+
+```bash
+ops -validate -r '^[a-z]+$' abc
+```
+
+
+
diff --git a/hugo.yaml b/hugo.yaml
index c95a1f7..09e6d3a 100644
--- a/hugo.yaml
+++ b/hugo.yaml
@@ -136,7 +136,7 @@ params:
url_latest_version: https://github.com/apache/openserverless/releases
# Repository configuration (URLs for in-page links to opening issues and
suggesting changes)
- github_repo: https://github.com/apache/openserverless/issues
+ github_repo: https://github.com/apache/openserverless-site
# An optional link to a related project repo. For example, the sibling
repository where your product code lives.
github_project_repo: https://github.com/apache/openserverless
