Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Documentation of API host

Aperta
#192 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
48/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
kubernetes

Direzione di ricerca

Inizia individuando la documentazione relativa all'installazione e il riferimento al comando ops. Verifica i workflow Kubernetes, TLS, local miniops, external-load-balancer e ops setup mini rispetto ai comandi nell'issue. Il lavoro è completato quando ogni percorso di configurazione, prerequisito, protocollo ed esempio è documentato correttamente.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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 <domain> [--tls=<email>|--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)

Lingua principale
Python
Stelle
576
Fork
29
Merge medio
51m
PR unite (30g)
14

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di apache/openserverless

Tutte le issue di apache/openserverless

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.