cloudfoundry/cf-k8s-controllers

View on GitHub
controllers/api/v1alpha1/buildworkload_types.go

Summary

Maintainability
A
0 mins
Test Coverage
/*
Copyright 2022.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package v1alpha1

import (
    v1 "k8s.io/api/core/v1"
    metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

const (
    BuildWorkloadFinalizerName = "kpack-image-builder.korifi.cloudfoundry.org/buildworkload"
)

// BuildWorkloadSpec defines the desired state of BuildWorkload
type BuildWorkloadSpec struct {
    // A reference to the CFBuild that requested the build. The CFBuild must be in the same namespace
    BuildRef RequiredLocalObjectReference `json:"buildRef"`

    // The details necessary to pull the image containing the application source
    Source PackageSource `json:"source,omitempty"`

    // Buildpacks to include in auto-detection when building the app image.
    // If no values are specified, then all available buildpacks will be used for auto-detection
    Buildpacks []string `json:"buildpacks,omitempty"`

    // The environment variables to set on the container that builds the image
    Env []v1.EnvVar `json:"env,omitempty"`

    Services []v1.ObjectReference `json:"services,omitempty"`

    // The name of the builder that should reconcile this BuildWorkload resource and execute the image building
    // +kubebuilder:validation:Required
    BuilderName string `json:"builderName"`
}

// BuildWorkloadStatus defines the observed state of BuildWorkload
type BuildWorkloadStatus struct {
    //+kubebuilder:validation:Optional
    Conditions []metav1.Condition `json:"conditions,omitempty"`

    Droplet *BuildDropletStatus `json:"droplet,omitempty"`

    // ObservedGeneration captures the latest generation of the BuildWorkload that has been reconciled
    ObservedGeneration int64 `json:"observedGeneration,omitempty"`
}

//+kubebuilder:object:root=true
//+kubebuilder:subresource:status

// BuildWorkload is the Schema for the buildworkloads API
type BuildWorkload struct {
    metav1.TypeMeta   `json:",inline"`
    metav1.ObjectMeta `json:"metadata,omitempty"`

    Spec   BuildWorkloadSpec   `json:"spec,omitempty"`
    Status BuildWorkloadStatus `json:"status,omitempty"`
}

//+kubebuilder:object:root=true

// BuildWorkloadList contains a list of BuildWorkload
type BuildWorkloadList struct {
    metav1.TypeMeta `json:",inline"`
    metav1.ListMeta `json:"metadata,omitempty"`
    Items           []BuildWorkload `json:"items"`
}

func init() {
    SchemeBuilder.Register(&BuildWorkload{}, &BuildWorkloadList{})
}