This is an automated email from the ASF dual-hosted git repository.
miki3421 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 f639349e better install instructions (#95)
f639349e is described below
commit f639349ee5590bb6efcd81843a58d373493c0aa3
Author: Michele Sciabarra <[email protected]>
AuthorDate: Wed Sep 9 20:37:13 2026 +0200
better install instructions (#95)
* cleaning quick start
* better install instructions
---------
Co-authored-by: Michele Sciabarra <[email protected]>
---
assets/scss/_variables_project.scss | 1 +
content/en/_index.md | 9 ++-
content/en/docs/installation/install-cli/_index.md | 61 ++++++++++------
content/en/docs/installation/quickstart/_index.md | 81 +++++++++++++++-------
4 files changed, 102 insertions(+), 50 deletions(-)
diff --git a/assets/scss/_variables_project.scss
b/assets/scss/_variables_project.scss
index e1fd8155..790e0635 100644
--- a/assets/scss/_variables_project.scss
+++ b/assets/scss/_variables_project.scss
@@ -2,4 +2,5 @@ $font-family-base: "Quattrocento";
$td-enable-google-fonts: false;
$primary: #265d85 !default;
+$warning: #ffc107 !default;
diff --git a/content/en/_index.md b/content/en/_index.md
index 47f26ec1..e3df6828 100644
--- a/content/en/_index.md
+++ b/content/en/_index.md
@@ -4,11 +4,14 @@ title: Apache OpenServerless™
{{< blocks/cover title="Welcome to Apache OpenServerless™ (incubating)!"
height="full" >}}
+<a class="btn btn-lg btn-warning me-3 mb-4"
href="/docs/installation/quickstart/">
+ Quick Start <i class="fas fa-bolt ms-2"></i>
+</a>
+<a class="btn btn-lg btn-primary me-3 mb-4"
href="/docs/installation/install-cli/">
+ Install CLI <i class="fas fa-download ms-2 "></i>
+</a>
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/">
Learn More <i class="fas fa-arrow-alt-circle-right ms-2"></i>
-</a>
-<a class="btn btn-lg btn-secondary me-3 mb-4"
href="/docs/installation/install-cli/">
- Install <i class="fas fa-download ms-2 "></i>
</a>
<h1 class="lead mt-5">Upgrading Kubernetes to a Serverless powerhouse to build
your cloud-native A.I. application!</h1>
diff --git a/content/en/docs/installation/install-cli/_index.md
b/content/en/docs/installation/install-cli/_index.md
index e846e5e5..b211a9f4 100644
--- a/content/en/docs/installation/install-cli/_index.md
+++ b/content/en/docs/installation/install-cli/_index.md
@@ -8,6 +8,24 @@ aliases:
---
## Install `ops`
+{{< blockquote warning "DISCLAIMER" >}}
+The prebuilt binaries published on the
+[openserverless-cli
releases](https://github.com/apache/openserverless-cli/releases)
+page are **convenience builds** only. They are **not** official Apache
releases,
+they are **not** endorsed by the Apache Software Foundation, and they are
+**not** meant to be production ready. The only official artifacts are the
+source releases; build from source with `go install` if you need a supported,
+production-grade installation.
+
+Apache OpenServerless is also an effort undergoing **incubation** at the Apache
+Software Foundation. Incubation is required of all newly accepted projects
+until a further review indicates that the infrastructure, communications and
+decision making process have stabilized in a manner consistent with other
+successful ASF projects. While incubation status is not necessarily a
+reflection of the completeness or stability of the code, it does indicate that
+the project has yet to be fully endorsed by the ASF.
+{{< /blockquote >}}
+
### What is `ops`?
As you can guess it helps with operations: ops is the
<strong>OP</strong>en<strong>S</strong>erverless CLI.
@@ -21,7 +39,7 @@ It is a task executor on steroids.
The predefined set of tasks are all you need to install and manage an
OpenServerless cluster.
-### Install with `go install`
+### Install CLI
You install `ops` by building it from the official Apache sources with a Go
compiler. You need [Go](https://go.dev/dl/) installed first.
@@ -30,11 +48,13 @@ compiler. You need [Go](https://go.dev/dl/) installed first.
go install github.com/apache/openserverless-cli/cmd/[email protected]
```
+{{< details title="Installing a specific version" >}}
You can replace `0.9.0` with any other version you want to install, including
unreleased ones — for example a snapshot such as
`v0.9.0-2609031727.SNAPSHOT`. The available versions are the tags of the
[openserverless-cli](https://github.com/apache/openserverless-cli/tags)
repository.
+{{< /details >}}
This installs `ops` into `$(go env GOPATH)/bin`. Make sure that directory is on
your `PATH`:
@@ -43,6 +63,24 @@ your `PATH`:
export PATH="$PATH:$(go env GOPATH)/bin"
```
+### Download a convenience build
+
+If you prefer not to build from source, prebuilt binaries for the most common
+platforms are published as convenience builds at:
+
+[https://github.com/apache/openserverless-cli/releases](https://github.com/apache/openserverless-cli/releases)
+
+Download the archive matching your operating system and architecture, extract
+the `ops` executable and place it in a directory on your `PATH`.
+
+On **macOS**, binaries downloaded from the Internet are quarantined by
+Gatekeeper and refuse to run. Remove the quarantine attribute before using
+`ops`:
+
+```bash
+xattr -d com.apple.quarantine ops
+```
+
### Check the installation
Once installed, check that `ops` is set up correctly:
@@ -78,27 +116,6 @@ Check that `OPS_REPO` is
`http://github.com/apache/openserverless-task` and that
Use `ops -t` to list the available tasks.
-## Create a local OpenServerless
-
-If you have [Docker](https://docs.docker.com/get-started/get-docker/)
installed,
-you can now create a complete OpenServerless on your own machine with a single
-command:
-
-```bash
-ops setup mini
-```
-
-This is the fastest way to get a working system, and the recommended starting
-point: it installs everything locally, so you can try OpenServerless without a
-cluster and without a cloud account.
-
-When it finishes, follow the [Quick Start](/docs/installation/quickstart/) to
-deploy your first action.
-
-To install on a real cluster instead — Kubernetes, K3s, MicroK8s, EKS, AKS, GKE
-and more — check the [prerequisites](/docs/installation/prereq/) and then the
-[installation guides](/docs/installation/install/).
-
### Keeping it up to date
`ops` will tell you when its tasks need updating:
diff --git a/content/en/docs/installation/quickstart/_index.md
b/content/en/docs/installation/quickstart/_index.md
index 04514964..c4a6677e 100644
--- a/content/en/docs/installation/quickstart/_index.md
+++ b/content/en/docs/installation/quickstart/_index.md
@@ -5,6 +5,23 @@ weight: 5
---
## Quick Start
+{{< blockquote warning "DISCLAIMER" >}}
+The prebuilt binaries are **convenience builds** only.
+They are **not** official Apache releases,
+they are **not** endorsed by the Apache Software Foundation, and they are
+**not** meant to be production ready. The only official artifacts are the
+source releases; build from source with `go install` if you need a supported,
+production-grade installation.
+
+Apache OpenServerless is also an effort undergoing **incubation** at the Apache
+Software Foundation. Incubation is required of all newly accepted projects
+until a further review indicates that the infrastructure, communications and
+decision making process have stabilized in a manner consistent with other
+successful ASF projects. While incubation status is not necessarily a
+reflection of the completeness or stability of the code, it does indicate that
+the project has yet to be fully endorsed by the ASF.
+{{< /blockquote >}}
+
This is a quick start guide to the installation process, targeting
experienced users in a hurry.
@@ -24,36 +41,38 @@ Start ensuring the prerequsites are satisfied:
We support 64-bit versions of recent Windows, MacOS and major Linux
distributions.
-- Check that ops is correctly installed: open the terminal and write:
+ You can download a prebuilt convenience binary for your platform
+ [here](https://github.com/apache/openserverless-cli/releases).
+ On macOS, remove the Gatekeeper quarantine attribute before running it:
- ops -info
+ ```bash
+ xattr -d com.apple.quarantine ops
+ ```
-- Configure the services you want to enable. By default,
- OpenServerless will install only the serverless engine, accessible
- in http with no services enabled.
+ **Hint:** if you already have [Go](https://go.dev) installed, you can
+ skip the installer entirely and just do:
-If you want to enable all the services, use:
+ ```bash
+ go install github.com/apache/openserverless-cli/cmd/[email protected]
+ ```
- ops config enable --all
+- Check that ops is correctly installed: open the terminal and write:
-otherwise pick the services you want, among `--redis`, `--mongodb`,
-`--minio`, `--cron`, `--postgres`. Note that `--mongodb` is actually
-[FerretDB](https://www.ferretdb.com/) and requires Postgres which is
-implicitly also enabled. More details [here](/docs/installation/configure).
+ ops -info
Now, choose where to install OpenServerless.
Your options are:
-- [locally](#locally) in your workstation;
+- [locally](#local-installation) in your workstation;
-- in a Linux [server](#server) in your intranet
+- in a Linux [server](#server-installation) in your intranet
-- in a Linux [server](#internet-server) available on Internet
+- in a Linux [server](#internet-server-configuration) available on Internet
-- in a Kubernetes [cluster](#cluster) in your intranet
+- in a Kubernetes [cluster](#cluster-install) in your intranet
-- in [cloud](#cloud-cluster), where you can provision a Kubernetes
+- in [cloud](#cloud-cluster-provisioning), where you can provision a Kubernetes
cluster
## Local Installation
@@ -72,7 +91,10 @@ then install OpenServerless in it. Once you have:
Make sure Docker Desktop its running before the next operation. Install
OpenServerless and its services in Docker with just this
command:
- ops setup devcluster
+ ops setup mini
+
+This is the recommended way to run OpenServerless locally. It requires
+**16GB of memory** and **60GB of free disk space**.
Once it is installed, you can proceed to read the
[tutorial](#../../tutorial/index.adoc) to learn how to code with it.
@@ -88,6 +110,15 @@ doing and can tolerate inefficiency, you can install with
less using:
If you have access to a server on the Internet, you will know its **IP
address**.
+{{< blockquote important >}}
+The server must have a **public IP address**, reachable from the Internet, for
+the whole duration of the installation. This is not optional: the setup obtains
+TLS certificates from Let's Encrypt, which validates your domain by connecting
+back to your server from the outside. If the IP is private, behind NAT, or
+otherwise unreachable, that validation fails and **the installation will not
+work**.
+{{< /blockquote >}}
+
Many cloud providers also give you a DNS name usually derived by the IP
and very hard to remember such as
`ec2-12-34-56-78.us-west-2.compute.amazonaws.com`.
@@ -169,15 +200,15 @@ install OpenServerless with no issues.
We provide the support to easily configure and install a compliant
Kubernetes cluster for the following clouds:
-- [Amazon AWS](#aws)
+- [Amazon AWS](#amazon-aws)
-- [Microsoft Azure](#azure)
+- [Microsoft Azure](#azure-aks)
-- [Google Cloud](#gcloud)
+- [Google Cloud](#google-cloud-gke)
At the end of the installation you will have available and accessible a
Kubernetes Cluster able to install OpenServerless, so proceed with a
-[cluster installation](#cluster).
+[cluster installation](#cluster-install).
### Amazon AWS
@@ -186,7 +217,7 @@ Configure and install an Amazon EKS cluster on Amazon AWS
with:
ops config eks
ops cloud eks create
-then [install the cluster](#cluster).
+then [install the cluster](#cluster-install).
### Azure AKS
@@ -195,7 +226,7 @@ Configure and install an Azure AKS cluster on Microsoft
Azure with:
ops config aks
ops cloud aks create
-then [install the cluster](#cluster).
+then [install the cluster](#cluster-install).
### Google Cloud GKE
@@ -204,7 +235,7 @@ Configure and install a Google Cloud GKE with:
ops config gke
ops cloud gke create
-then [install the cluster](#cluster).
+then [install the cluster](#cluster-install).
## Cluster Install
@@ -232,7 +263,7 @@ you can install OpenServerless in it. You can read [more
details
here](#../prereq/kubernetes/cluster/index.adoc).
You can get this access either by provisioning a Kubernetes cluster in
-[cloud](#cloud-cluster) or getting access to it from your system
+[cloud](#cloud-cluster-provisioning) or getting access to it from your system
administrator.
Whatever the way you get access to your Kubernetes cluster, you will end
