From 588ee670ef420fb4dd7fbe4cdd116bb5901b0bb7 Mon Sep 17 00:00:00 2001 From: Amalthea Bot Date: Mon, 20 Sep 2021 09:06:05 +0000 Subject: [PATCH] chore(docs): update CRD docs --- docs/crd.md | 661 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 661 insertions(+) create mode 100644 docs/crd.md diff --git a/docs/crd.md b/docs/crd.md new file mode 100644 index 00000000..bd3e3068 --- /dev/null +++ b/docs/crd.md @@ -0,0 +1,661 @@ +# API Reference + +Packages: + +- [amalthea.dev/v1alpha1](#amaltheadevv1alpha1) + +# amalthea.dev/v1alpha1 + +Resource Types: + +- [JupyterServer](#jupyterserver) + + + + +## JupyterServer +[↩ Parent](#amaltheadevv1alpha1 ) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
apiVersionstringamalthea.dev/v1alpha1true
kindstringJupyterServertrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the `metadata` field.true
specobject +
+ 		false
statusobject +
+
+ Default: map[children:map[] mainPod:map[]]
+ 		false
+ + +### JupyterServer.spec +[↩ Parent](#jupyterserver) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
authobject +
+
+ Default: map[]
+ 		false
cullingobject + Options about culling idle servers
+
+ Default: map[]
+ 		false
jupyterServerobject +
+
+ Default: map[]
+ 		false
patches[]object + Patches to be applied. Currently only json patches and json merge +patches are supported. +
+
+ Default: []
+ 		false
routingobject +
+
+ Default: map[]
+ 		false
storageobject +
+
+ Default: map[]
+ 		false
+ + +### JupyterServer.spec.auth +[↩ Parent](#jupyterserverspec) + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
oidcobject +
+
+ Default: map[]
+ 		false
tokenstring + A token that will be passed to the `--ServerApp.token` option when running +the Jupyter server and needed when first accessing the Jupyter server. The +options are: +- By leaving this field empty, a token will be autogenerated and added under the + key `ServerApp.token` to the secret which is created as a child of the custom + resource object. +- Setting the token to an empty string "" runs the Jupyter server container + itself without any authentication. This is recommended when enabling OIDC + as authentication and authorization are then handled by the dedicated plugins. +- Set an actual value here. Note that this string will be stored in clear text + as part of the custom resource object. This option is mostly useful for dev + purposes. +
+ 		false
+ + +### JupyterServer.spec.auth.oidc +[↩ Parent](#jupyterserverspecauth) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
authorizedEmails[]string + List of users (identified by Email address read from the "email" OIDC claim) +which are allowed to access this Jupyter session. This list is stored as a file +and passed to the `--authenticated-emails-file` option (see +https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/overview#command-line-options). +
+
+ Default: []
+ 		false
authorizedGroups[]string + List of groups of users (read from the "groups" OIDC claim) which are allowed +to access this Jupyter session. This list passed to the `--allowed-group` option (see +https://oauth2-proxy.github.io/oauth2-proxy/docs/configuration/overview#command-line-options). +
+
+ Default: []
+ 		false
clientIdstring +
+ 		false
clientSecretobject + The client secret of the application registered with the OIDC provider. This +secret can be given here explicitly as string or through a reference to an +existing secret. Using the secret reference is the preferred option because it +avoids storing the secret in cleartext on the custom resource specification. +
+ 		false
enabledboolean +
+
+ Default: false
+ 		false
issuerUrlstring +
+ 		false
+ + +### JupyterServer.spec.auth.oidc.clientSecret +[↩ Parent](#jupyterserverspecauthoidc) + + + +The client secret of the application registered with the OIDC provider. This +secret can be given here explicitly as string or through a reference to an +existing secret. Using the secret reference is the preferred option because it +avoids storing the secret in cleartext on the custom resource specification. + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
secretKeyRefobject + A regular reference to the key/secret which holds the client secret of the +application registered with the OIDC provider. Note that the secret has to +be in the same namespace in which the custom resource object is going to be +created. +
+ 		false
valuestring +
+ 		false
+ + +### JupyterServer.spec.auth.oidc.clientSecret.secretKeyRef +[↩ Parent](#jupyterserverspecauthoidcclientsecret) + + + +A regular reference to the key/secret which holds the client secret of the +application registered with the OIDC provider. Note that the secret has to +be in the same namespace in which the custom resource object is going to be +created. + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
keystring +
+ 		false
namestring +
+ 		false
+ + +### JupyterServer.spec.culling +[↩ Parent](#jupyterserverspec) + + + +Options about culling idle servers + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
idleSecondsThresholdinteger + How long should a server be idle for before it is culled. A value of zero +indicates that the server should never be culled. +
+
+ Default: 0
+ Minimum: 0
+ 		false
+ + +### JupyterServer.spec.jupyterServer +[↩ Parent](#jupyterserverspec) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
defaultUrlstring +
+
+ Default: /lab
+ 		false
imagestring +
+
+ Default: jupyter/minimal-notebook:latest
+ 		false
resourcesobject + Regular resource requests, will be set on the main notebook +container. +
+
+ Default: map[]
+ 		false
rootDirstring + The absolute path to the root/notebook directory for jupyterlab. Should +lead to a subdirectory of or match the path at storage.pvc.mountPath +
+
+ Default: /home/jovyan/work
+ 		false
+ + +### JupyterServer.spec.patches[index] +[↩ Parent](#jupyterserverspec) + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
patchJSON +
+ 		false
typeenum +
+
+ Enum: application/json-patch+json, application/merge-patch+json
+ 		false
+ + +### JupyterServer.spec.routing +[↩ Parent](#jupyterserverspec) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
hoststring +
+ 		false
ingressAnnotationsobject +
+
+ Default: map[]
+ 		false
pathstring +
+
+ Default: /
+ 		false
tlsobject +
+
+ Default: map[]
+ 		false
+ + +### JupyterServer.spec.routing.tls +[↩ Parent](#jupyterserverspecrouting) + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean +
+
+ Default: false
+ 		false
secretNamestring +
+ 		false
+ + +### JupyterServer.spec.storage +[↩ Parent](#jupyterserverspec) + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
pvcobject +
+
+ Default: map[]
+ 		false
sizestring + Size of the PVC or sizeLimit of the emptyDir volume which +backs the session respectively. +
+
+ Default: 100Mi
+ 		false
+ + +### JupyterServer.spec.storage.pvc +[↩ Parent](#jupyterserverspecstorage) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
enabledboolean + Wether a PVC should be used to back the session. Defaults +to 'false' in which case an emptyDir volume will be used. +
+
+ Default: false
+ 		false
mountPathstring + The absolute path to the location where the PVC should be +mounted in the user session pod. +
+
+ Default: /home/jovyan/work
+ 		false
storageClassNamestring + Storage class to be used for the PVC. If left empty, the +default storage class defined for the cluster will be used. +
+ 		false
\ No newline at end of file