codius-operator

README

Codius Operator

Kubebuilder-based operator for Codius custom resource definition

Dependencies

• cert-manager for admission webhooks

Run

sudo make docker-build docker-push IMG=<some-registry>/<project-name>:tag
make deploy IMG=<some-registry>/<project-name>:tag

Environment Variables

Configure by patching the controller manager deployment with Kustomize.

CODIUS_HOSTNAME

• Type: String
• Description: Hostname of the Codius host

CODIUS_HELLO_SVC_URL

• Type: String
• Description: URL for the internal hello service. Codius service deployment initContainers will query the hello service to determine when the pod's egress network policy has been enforced.

CODIUS_WEB_URL

• Type: String
• Description: URL of the Codius web frontend.

CODIUS_NAMESPACE

• Type: String
• Description: Namespace in which to create deployments, services, and ingresses. The operator controller manager must have the necessary permissions in this namespace. This is also the namespace to which the network policy should be applied.

RECEIPT_VERIFIER_URL

• Type: String
• Description: URL of the receipt verifier with which to deduct paid balances.

REQUEST_PRICE

• Type: Number
• Description: The amount required to have been paid to serve a request. Denominated in the host's asset (code and scale).

RUNTIME_CLASS_NAME

• Type: String
• Description: RuntimeClass to use for Codius service deployments' runtimeClassName

SERVICE_PRICE

• Type: Number
• Description: The amount required to have been paid to create a service. Denominated in the host's asset (code and scale).

API Documentation

PUT /services/{ID}

Create a Codius service

Request Body:

• Type: Object

Field Name	Type	Description
spec	Object	An object containing details for your service.
secretData	Object	An object containing private variables you want to pass to the host, such as an AWS key.

GET /services/{ID}

Retrieve the specified Codius service