apache / apache/openserverless
Documentation of API host
- Dominant language
- Python
- Stars
- 576
- Forks
- 29
- Avg merge
- 50m
- Merged PRs (30d)
- 13
Description
Add in the documentation something to explain this:
to install openserverless you need admin access to a kubernetes cluster
with an ingress and point an entire domain to the ip of the ingress,
if you want also ssl you need to add also the cert-manager
before installing you need to correctly set the apihost with
`ops config apihost [--tls=|--protocol=(https|https)]`
enable the services you want
`ops config enable --all`
and then install with
`ops setup kubernetes create`
in the more general case you (https with public ip and ssl) once you created the the domanin (* and @ records pointing to the ingress ip) you do
ops config apihost sciabarra.net --tls=
ops config enable --all
ops setup kubernetes create
if you want to do a local install we have a special domain, miniops.me with *.miniops.me and miniops.me points to 127.0.0.1, this is for private installation, localhost only.
In this case you do:
ops config apihost miniops.me
ops config enable --all
ops setup kubernetes
note that in this case you are going to use http:
you may also have an https load balancer in front of the server
in this case you do
ops config apihost external-domain --protocol=https
ops config enable --all
ops setup kubernetes
in this case the service is internally http but externally is served as https so you do not need a cert-manager but provision an external load balancer
# miniops
doing `ops setup mini` enable all the services set the apihost to miniops and installs a devcluster (a kind cluster)
Contributor guide
Research direction
Start by locating the installation documentation and the `ops` command reference. Verify the Kubernetes, TLS, local miniops, external-load-balancer, and `ops setup mini` workflows against the commands in the issue. Done means each setup path, prerequisite, protocol, and example is documented accurately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- cloud, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100