API Reference
Packages
octorun.github.io/v1alpha1
Package v1alpha1 contains API Schema definitions for the v1alpha1 API group
Resource Types
Runner
Runner is the Schema for the runners API
Appears in:
| Field | Description |
|---|---|
apiVersion string | octorun.github.io/v1alpha1 |
kind string | Runner |
TypeMeta TypeMeta | |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec RunnerSpec | |
status RunnerStatus |
RunnerImage
Appears in:
| Field | Description |
|---|---|
name string | Runner Container image name. |
pullPolicy PullPolicy | Image pull policy. One of Always, Never, IfNotPresent. |
pullSecrets LocalObjectReference array | An optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec. If specified, these secrets will be passed to individual puller implementations for them to use. For example, in the case of docker, only DockerConfig type secrets are honored. More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod |
RunnerList
RunnerList contains a list of Runner
| Field | Description |
|---|---|
apiVersion string | octorun.github.io/v1alpha1 |
kind string | RunnerList |
TypeMeta TypeMeta | |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items Runner array |
RunnerPlacement
Appears in:
| Field | Description |
|---|---|
nodeSelector object (keys:string, values:string) | A selector which must be true for the pod to fit on a node. Selector which must match a node’s labels for the pod to be scheduled on that node. More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ |
tolerations Toleration array | If specified, the pod’s tolerations. |
affinity Affinity | If specified, the pod’s scheduling constraints |
RunnerSet
RunnerSet is the Schema for the runnersets API
Appears in:
| Field | Description |
|---|---|
apiVersion string | octorun.github.io/v1alpha1 |
kind string | RunnerSet |
TypeMeta TypeMeta | |
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec RunnerSetSpec | |
status RunnerSetStatus |
RunnerSetList
RunnerSetList contains a list of RunnerSet
| Field | Description |
|---|---|
apiVersion string | octorun.github.io/v1alpha1 |
kind string | RunnerSetList |
TypeMeta TypeMeta | |
metadata ListMeta | Refer to Kubernetes API documentation for fields of metadata. |
items RunnerSet array |
RunnerSetSpec
RunnerSetSpec defines the desired state of RunnerSet
Appears in:
| Field | Description |
|---|---|
runners integer | Runners is the number of desired runners. This is a pointer to distinguish between explicit zero and unspecified. Defaults to 1. |
selector LabelSelector | Selector is a label query over runners that should match the replica count. Label keys and values that must match in order to be controlled by this RunnerSet. It must match the runner template’s labels. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors |
template RunnerTemplateSpec | Template is the object that describes the runner that will be created if insufficient replicas are detected. |
RunnerSetStatus
RunnerSetStatus defines the observed state of RunnerSet
Appears in:
| Field | Description |
|---|---|
runners integer | Runners is the most recently observed number of runners. |
idleRunners integer | The number of idle runners for this RunnerSet. |
activeRunners integer | The number of active runners for this RunnerSet. |
conditions Condition array | Conditions defines current service state of the runner. |
selector string | Selector is the same as the label selector but in the string format to avoid introspection by clients. The string will be in the same format as the query-param syntax. More info about label selectors: http://kubernetes.io/docs/user-guide/labels#label-selectors |
RunnerSpec
RunnerSpec defines the desired state of Runner
Appears in:
| Field | Description |
|---|---|
url string | The github Organization or Repository URL for this runner. Must be a valid Github Org or Repository URL. eg: - “https://github.com/org” - “https://github.com/org/repo” |
id integer | ID of the runner assigned by Github, basically it is sequential number. Read-only. |
os string | OS type of the runner. Populated by the system. Read-only. |
group string | Name of the runner group to add to this runner. Defaults to Default. |
workdir string | Relative runner work directory. |
image RunnerImage | Runner container image specification |
placement RunnerPlacement | Placement configuration to pass to kubernetes pod (affinity, node selector, etc). |
resources ResourceRequirements | Compute resources required by runner container. |
serviceAccountName string | ServiceAccountName is the name of the ServiceAccount to use to run this runner pod. More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/ |
securityContext SecurityContext | SecurityContext holds security configuration that will be applied to the runner container. |
runtimeClassName string | RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run this runner pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the “legacy” RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. |
volumes Volume array | List of volumes that can be mounted by runner container belonging to the runner pod. |
volumeMounts VolumeMount array | Runner pod volumes to mount into the runner container filesystem. |
RunnerStatus
RunnerStatus defines the observed state of Runner
Appears in:
| Field | Description |
|---|---|
phase RunnerPhase | Phase represents the current phase of runner. |
conditions Condition array | Conditions defines current service state of the runner. |
RunnerTemplateSpec
RunnerTemplateSpec describes the data a runner should have when created from a template
Appears in:
| Field | Description |
|---|---|
metadata ObjectMeta | Refer to Kubernetes API documentation for fields of metadata. |
spec RunnerSpec | Specification of the desired behavior of the runner. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status |