Project Controller API Reference

Packages

projctl.konflux.dev/v1beta1

Package v1beta1 contains API Schema definitions for the projctl v1beta1 API group

Resource Types

Project

Project is the Schema for the projects API

Appears In:
Field Description Default Validation

apiVersion string

projctl.konflux.dev/v1beta1

kind string

Project

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ProjectSpec

ProjectDevelopmentStream

ProjectDevelopmentStream is the Schema for the projectdevelopmentstreams API

Appears In:
Field Description Default Validation

apiVersion string

projctl.konflux.dev/v1beta1

kind string

ProjectDevelopmentStream

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ProjectDevelopmentStreamSpec

status ProjectDevelopmentStreamStatus

ProjectDevelopmentStreamList

ProjectDevelopmentStreamList contains a list of ProjectDevelopmentStream

Field Description Default Validation

apiVersion string

projctl.konflux.dev/v1beta1

kind string

ProjectDevelopmentStreamList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items ProjectDevelopmentStream array

ProjectDevelopmentStreamSpec

ProjectDevelopmentStreamSpec defines the desired state of ProjectDevelopmentStream

Appears In:
Field Description Default Validation

project string

The name of the project this stream belongs to

template ProjectDevelopmentStreamSpecTemplateRef

An optional template to use for creating resources owned by this
ProjectDevelopmentStream

ProjectDevelopmentStreamSpecTemplateRef

ProjectDevelopmentStreamSpecTemplateRef defines which optional template is associated with this ProjectDevelopmentStream and how to apply it

Appears In:
Field Description Default Validation

name string

The name of the ProjectDevelopmentStreamTemplate to use

values ProjectDevelopmentStreamSpecTemplateValue array

Values for template variables

ProjectDevelopmentStreamSpecTemplateValue

Provide a value for a variable specified in an associated ProjectDevelopmentStreamTemplate

Appears In:
Field Description Default Validation

name string

The name of the template variable to provide a value for

value string

The value to be placed in the template variable

ProjectDevelopmentStreamStatus

ProjectDevelopmentStreamStatus defines the observed state of ProjectDevelopmentStream

Appears In:
Field Description Default Validation

conditions Condition array

Represents the observations of a ProjectDevelopmentStream’s current state.
Known .status.conditions.type are: "TemplateApplied", and "TemplateGenerated"

ProjectDevelopmentStreamTemplate

ProjectDevelopmentStreamTemplate is the Schema for the projectdevelopmentstreamtemplates API

Appears In:
Field Description Default Validation

apiVersion string

projctl.konflux.dev/v1beta1

kind string

ProjectDevelopmentStreamTemplate

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec ProjectDevelopmentStreamTemplateSpec

ProjectDevelopmentStreamTemplateList

ProjectDevelopmentStreamTemplateList contains a list of ProjectDevelopmentStreamTemplate

Field Description Default Validation

apiVersion string

projctl.konflux.dev/v1beta1

kind string

ProjectDevelopmentStreamTemplateList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items ProjectDevelopmentStreamTemplate array

ProjectDevelopmentStreamTemplateSpec

ProjectDevelopmentStreamTemplateSpec defines the resources to be generated using a ProjectDevelopmentStreamTemplate

Appears In:
Field Description Default Validation

project string

The name of the project this stream template belongs to

variables ProjectDevelopmentStreamTemplateVariable array

List of variables to allow customizing the template results. The order
variables in the list is significant as earlier variables can be
referenced by the default values for later variables

resources UnstructuredObj array

List of resources to be created for version made from this template
certain values for resource properties may include references to
variables using the Go-text/template syntax

ProjectDevelopmentStreamTemplateVariable

Settings for a variable to be used to customize the template results

Appears In:
Field Description Default Validation

name string

Variable name

defaultValue string

Optional default value for use when a value for the variable is not given
can reference values of other previously defined variables using the Go
text/template syntax

description string

Optional description for the variable for display in the UI

ProjectList

ProjectList contains a list of Project

Field Description Default Validation

apiVersion string

projctl.konflux.dev/v1beta1

kind string

ProjectList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items Project array

ProjectSpec

ProjectSpec defines the desired state of Project

Appears In:
Field Description Default Validation

displayName string

A nice human-readable name to be displayed in the UI

description string

A text describing the project, its purpose, etc.

UnstructuredObj

Appears In:
Field Description Default Validation

Object object (keys:string, values:interface{})

Object is a JSON compatible map with string, float, int, bool, []interface{}, or
map[string]interface{}
children.