api/v1alpha1/appdeployment_types.go

/*
Copyright 2025.

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 (
	batchv1 "k8s.io/api/batch/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

const (
	AppDeploymentOwnerKey = ".appDeployment.metadata.controller"

	AppDeploymentFinalizerName = "finalizer.appdeployment.devinfra.goms.io"

	// phase types
	AppDeploymentPhaseEmpty     = ""
	AppDeploymentPhasePending   = "Pending"
	AppDeploymentPhaseDeploying = "Deploying"
	AppDeploymentPhaseReady     = "Ready"
	AppDeploymentPhaseDeleting  = "Deleting"
	AppDeploymentPhaseDeleted   = "Deleted"
)

// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.

// AppDeploymentSpec defines the desired state of AppDeployment.
type AppDeploymentSpec struct {
	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
	// Important: Run "make" to regenerate code after modifying this file
	// +kubebuilder:validation:Required
	Provision batchv1.JobSpec `json:"provision"`
	Teardown  batchv1.JobSpec `json:"teardown"`
	OpId      string          `json:"opId"`
	// +kubebuilder:validation:Optional
	Dependencies []string `json:"dependencies,omitempty"`
}

// AppDeploymentStatus defines the observed state of AppDeployment.
type AppDeploymentStatus struct {
	// INSERT ADDITIONAL STATUS FIELD - define observed state of cluster
	// Important: Run "make" to regenerate code after modifying this file
	Phase      string             `json:"phase"`
	Conditions []metav1.Condition `json:"conditions"`
}

// +kubebuilder:object:root=true
// +kubebuilder:subresource:status
// +kubebuilder:printcolumn:name="Phase",type="string",JSONPath=`.status.phase`
// +kubebuilder:printcolumn:name="Owner",type="string",JSONPath=`.metadata.ownerReferences[0].name`
// AppDeployment is the Schema for the appdeployments API.
type AppDeployment struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec   AppDeploymentSpec   `json:"spec,omitempty"`
	Status AppDeploymentStatus `json:"status,omitempty"`
}

// +kubebuilder:object:root=true

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

func init() {
	SchemeBuilder.Register(&AppDeployment{}, &AppDeploymentList{})
}