Skip to content

Commit

Permalink
Add kwokctl component api
Browse files Browse the repository at this point in the history
  • Loading branch information
wzshiming committed Mar 28, 2024
1 parent ab2304d commit 2d6fcac
Show file tree
Hide file tree
Showing 26 changed files with 1,244 additions and 34 deletions.
43 changes: 43 additions & 0 deletions pkg/apis/config/v1alpha1/kwokctl_component_types.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/*
Copyright 2024 The Kubernetes Authors.
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 (
"encoding/json"

metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

const (
// KwokctlComponentKind is the kind of the kwokctl component.
KwokctlComponentKind = "KwokctlComponent"
)

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object

// KwokctlComponent holds information about the kwokctl component.
type KwokctlComponent struct {
//+k8s:conversion-gen=false
metav1.TypeMeta `json:",inline"`
// Standard list metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta `json:"metadata,omitempty"`
// Parameters is the parameters for the kwokctl component configuration.
Parameters json.RawMessage `json:"parameters,omitempty"`
// Template is the template for the kwokctl component configuration.
Template string `json:"template,omitempty"`
}
20 changes: 20 additions & 0 deletions pkg/apis/config/v1alpha1/kwokctl_configuration_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -499,12 +499,20 @@ type Component struct {
// +optional
Volumes []Volume `json:"volumes,omitempty"`

// Files is a list of files that can be mounted by containers belonging to the component.
// +optional
Files []File `json:"files,omitempty"`

// Metric is the metric of the component.
Metric *ComponentMetric `json:"metric,omitempty"`

// MetricsDiscovery is the metrics discovery of the component.
MetricsDiscovery *ComponentMetric `json:"metricsDiscovery,omitempty"`

// Address is the address of the component.
// +optional
Address string `json:"address,omitempty"`

// Version is the version of the component.
// +optional
Version string `json:"version,omitempty"`
Expand Down Expand Up @@ -585,6 +593,18 @@ type Volume struct {
PathType HostPathType `json:"pathType,omitempty"`
}

// File represents a file that is accessible to the containers running in a component.
type File struct {
// Path is the path of the file.
Path string `json:"path"`
// Data is the content of the file.
Data string `json:"data,omitempty"`
// Template is the template of the file.
Template string `json:"template,omitempty"`
// Mode is the mode of the file.
Mode string `json:"mode,omitempty"`
}

// HostPathType represents the type of storage used for HostPath volumes.
// +enum
type HostPathType string
Expand Down
52 changes: 52 additions & 0 deletions pkg/apis/config/v1alpha1/zz_generated.deepcopy.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 22 additions & 0 deletions pkg/apis/internalversion/conversion.go
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,28 @@ func ConvertToInternalKwokctlResource(in *configv1alpha1.KwokctlResource) (*Kwok
return &out, nil
}

// ConvertToV1alpha1KwokctlComponent converts an internal version KwokctlComponent to a v1alpha1.KwokctlComponent.
func ConvertToV1alpha1KwokctlComponent(in *KwokctlComponent) (*configv1alpha1.KwokctlComponent, error) {
var out configv1alpha1.KwokctlComponent
out.APIVersion = configv1alpha1.GroupVersion.String()
out.Kind = configv1alpha1.KwokctlComponentKind
err := Convert_internalversion_KwokctlComponent_To_v1alpha1_KwokctlComponent(in, &out, nil)
if err != nil {
return nil, err
}
return &out, nil
}

// ConvertToInternalKwokctlComponent converts a v1alpha1.KwokctlComponent to an internal version.
func ConvertToInternalKwokctlComponent(in *configv1alpha1.KwokctlComponent) (*KwokctlComponent, error) {
var out KwokctlComponent
err := Convert_v1alpha1_KwokctlComponent_To_internalversion_KwokctlComponent(in, &out, nil)
if err != nil {
return nil, err
}
return &out, nil
}

// ConvertToV1alpha1KwokConfiguration converts an internal version KwokConfiguration to a v1alpha1.KwokConfiguration.
func ConvertToV1alpha1KwokConfiguration(in *KwokConfiguration) (*configv1alpha1.KwokConfiguration, error) {
var out configv1alpha1.KwokConfiguration
Expand Down
34 changes: 34 additions & 0 deletions pkg/apis/internalversion/kwokctl_component_types.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
/*
Copyright 2024 The Kubernetes Authors.
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 internalversion

import (
"encoding/json"

metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// KwokctlComponent provides component definition for kwokctl.
type KwokctlComponent struct {
// Standard list metadata.
// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
metav1.ObjectMeta
// Parameters is the parameters for the kwokctl component configuration.
Parameters json.RawMessage
// Template is the template for the kwokctl component configuration.
Template string
}
18 changes: 18 additions & 0 deletions pkg/apis/internalversion/kwokctl_configuration_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -332,12 +332,18 @@ type Component struct {
// Volumes is a list of named volumes that can be mounted by containers belonging to the component.
Volumes []Volume

// Files is a list of files that can be mounted by containers belonging to the component.
Files []File

// Metric is the metric of the component.
Metric *ComponentMetric

// MetricsDiscovery is the metrics discovery of the component.
MetricsDiscovery *ComponentMetric

// Address is the address of the component.
Address string

// Version is the version of the component.
Version string
}
Expand Down Expand Up @@ -408,6 +414,18 @@ type Volume struct {
PathType HostPathType
}

// File represents a file that is accessible to the containers running in a component.
type File struct {
// Path is the path of the file.
Path string
// Data is the content of the file.
Data string
// Template is the template of the file.
Template string
// Mode is the mode of the file.
Mode string
}

// HostPathType represents the type of storage used for HostPath volumes.
type HostPathType string

Expand Down
75 changes: 75 additions & 0 deletions pkg/apis/internalversion/zz_generated.conversion.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 2d6fcac

Please sign in to comment.