update documentation

pull/38/head
Max Erenberg 1 year ago
parent 0153cac644
commit 1e30efda24
  1. 60
      docs/ceod.ini.5.scd
  2. 24
      docs/openapi.yaml
  3. 15
      docs/redoc-static.html

@ -152,6 +152,66 @@ ceod.ini is an INI file with various sections which control the behaviour of ceo
_password_++
The password to use when connecting to PostgreSQL.
# CLOUDSTACK SECTION
_api\_key_++
The API key for CloudStack.
_secret\_key_++
The secret key for CloudStack.
_base\_url_++
The base URL for the CloudStack API.
# CLOUD VHOSTS SECTION
_acme\_challenge\_dir_++
The directory where the HTTP-01 challenge is performed for the ACME protocol.
_vhost\_dir_++
The directory where members' vhost files are stored.
_ssl\_dir_++
The directory where members' SSL certificates and keys are stored.
_default\_ssl\_cert_++
The SSL certificate used if a domain is a one-level subdomain of members\_domain.
_default\_ssl\_key_++
The SSL key used if a domain is a one-level subdomain of members\_domain.
_k8s\_ssl\_cert_++
The SSL certificate used if a domain is a one-level subdomain of k8s\_members\_domain.
_k8s\_ssl\_key_++
The SSL key used if a domain is a one-level subdomain of k8s\_members\_domain.
_rate\_limit\_seconds_++
The per-user rate limit in seconds for creating new vhosts.
_members\_domain_++
Members may create vhosts whose domains are subdomains of this one.
_k8s\_members\_domain_++
Similar to members\_domain, but for Kubernetes ingress purposes.
_ip\_range\_min_++
The minimum IP address in a vhost record.
_ip\_range\_max_++
The maximum IP address in a vhost record.
# K8S SECTION
_members\_clusterrole_++
The ClusterRole which will be bound to each member's namespace.
_members\_group_++
The Kubernetes group which each member will be part of.
_authority\_cert\_path_++
The path to the certificate used by the Kubernetes API server.
_server\_url_++
The URL of the Kubernetes API server.
# SEE ALSO
*ceo.ini*(5)

@ -821,6 +821,30 @@ paths:
type: string
description: IP address of the virtual host
example: {"vhosts": [{"domain": "ctdalek.m.csclub.cloud", "ip_address": "172.19.134.11"}]}
/cloud/k8s/account/create:
post:
tags: ['cloud']
servers:
- url: https://biloba.csclub.uwaterloo.ca:9987/api
summary: Activate a Kubernetes account
description: |
Create a Kubernetes namespace for the calling user. A new kubeconfig file will be returned.
If the namespace already exists, the certificate inside the kubeconfig will be renewed.
responses:
"200":
description: Success
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: '"OK"'
example: OK
kubeconfig:
type: string
description: the contents of a new kubeconfig file
components:
securitySchemes:
GSSAPIAuth:

File diff suppressed because one or more lines are too long
Loading…
Cancel
Save