Project

Scope: Cluster

v1alpha2v1alpha1
  • spec
    object
    • spec.description
      string

      Arbitrary description of the project’s purpose. Specify an empty string if no description is required.

    • spec.parameters
      object

      Parameters passed to the resources template when creating the project.

      Before creation, the values are validated against the schema of the template’s input parameters.

    • spec.projectTemplateName
      string

      The name of the ProjectTemplate resource that defines which resources will be created in the project.

Deprecated resource. Support for the resource might be removed in a later release.

  • spec
    object
    • spec.description
      string

      Arbitrary description of the project’s purpose. Specify an empty string if no description is required.

    • spec.projectTypeName
      string

      The name of the ProjectType resource that defines which resources will be created in the project.

    • spec.template
      object

      Values passed to the resources template when creating the project. Before creation, the values are validated against the schema of the template’s input parameters.

ProjectTemplate

Scope: Cluster
Version: v1alpha1

Describes the project template.

This resource is referenced by the Project custom resource.

  • spec
    object
    • spec.description
      string

      Arbitrary description of the template’s purpose. Specify an empty string if no description is required.

    • spec.parametersSchema
      object

      Required value

      One of parameters schema to validate parameters of a project.

      For now only OpenAPI v3 schema is supported.

      • spec.parametersSchema.openAPIV3Schema
        object

        Required value

        OpenAPI specification for parameters.

        This is used to check the validity of the parameters that are passed when creating a new project.

    • spec.resourcesTemplate
      string

      Required value

      A template that defines resources in the go template format to be created when setting up a new project.

      Templates are fully compatible with all helm functions.

      Read more about creating an isolated Environment…

      The following parameters are available in templates:

      • {{ .projectName }} — the name of the Project for which the template is being rendered.
      • {{ .projectTemplateName }} — the name of the ProjectTemplate.
      • {{ .parameters }} — a dictionary of custom values, described in the .spec.parametersSchema and defined in the .spec.parameters.

      Note! Specifying .metadata.namespace fields for objects is optional, as this field is automatically set with the name of the created project.