Skip to main content

GitHub Runner

General

The GitHubRunner is a read-only resource that provides status information about the claimed GitHub runner. While the GitHubRunnerClaim is used to request and set up a runner, the GitHubRunner reflects the current operational state of that runner within the system.

metadata section

The metadata section is used to uniquely identify objects and to provide other information that is not directly tied to a resource's configuration.

namespace: string

Namespace defines the space within which each GitHubRunner name must be unique.

name: string

Each GitHubRunner name must be unique, within a namespace. The name must contain only lower-case letters, digits and dashes.

More Details

In this section, we've described only two fields that are necessary and sufficient for users on Puzl. For a more in-depth explanation of metadata and its various fields, refer to the official Kubernetes documentation.

spec section

The section defines the desired state of the object. It describes the characteristics you want the resource to have: its configuration, settings, and data.

spec.runnerClaimRef

name
: string
Path:spec.runnerClaimRef.name

Name of the GitHubRunnerClaim resource initiated this GitHubRunner resource creation.

namespace
: string
Path:spec.runnerClaimRef.namespace

Namespace of the GitHubRunnerClaim resource initiated this GitHubRunner resource creation.

spec.manifestRef

name
: string
Path:spec.manifestRef.name

Internal system reference to the applied service manifest.

spec.releaseRef

Internal system reference to the runner release.

name
: string
Path:spec.releaseRef.name
namespace
: string
Path:spec.releaseRef.namespace
revision
: integer
Path:spec.releaseRef.revision
jobNamespaceRef
: string
Path:spec.jobNamespaceRef

status section

The section provides information about the current state of the object. It is populated by the platform and is used to inform users about the state of the resource, whether it's currently operational, and additional metadata like timestamps.

phase
: string
Default:Pending
Path:status.phase

Represents the high-level summary of the current status of the resource.

status.conditions[]

Conditions are designed based on Kubernetes API conventions. Conditions represent the logical states that the resource has passed through.

lastTransitionTime
: string
Path:status.conditions[].lastTransitionTime

The last time the condition transitioned from one status to another.

observedGeneration
: integer
Path:status.conditions[].observedGeneration

The value of metadata.generation when the condition has been transited last time.

message
: string
Path:status.conditions[].message

A human-readable message indicating details about the transition.

reason
: string
Path:status.conditions[].reason

A one-word, CamelCase reason caused the transition of the resource to this condition.

status
: string
Path:status.conditions[].status

The current status of the condition. Can be one of: True, False, or Unknown.

type
: string
Path:status.conditions[].type

Unique type of the resource condition.