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 Apr 7, 2024
1 parent 37b7812 commit 8e29a06
Show file tree
Hide file tree
Showing 21 changed files with 756 additions and 3 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"`
}
4 changes: 4 additions & 0 deletions pkg/apis/config/v1alpha1/kwokctl_configuration_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -505,6 +505,10 @@ type Component struct {
// 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
31 changes: 31 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
}
3 changes: 3 additions & 0 deletions pkg/apis/internalversion/kwokctl_configuration_types.go
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,9 @@ type Component struct {
// 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
37 changes: 37 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.

22 changes: 22 additions & 0 deletions pkg/apis/internalversion/zz_generated.deepcopy.go

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

6 changes: 6 additions & 0 deletions pkg/config/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,12 @@ var configHandlers = map[string]configHandler{
MutateToInternal: mutateToInternalConfig(internalversion.ConvertToInternalKwokctlResource),
MutateToVersiond: mutateToVersiondConfig(internalversion.ConvertToV1alpha1KwokctlResource),
},
configv1alpha1.KwokctlComponentKind: {
Unmarshal: unmarshalConfig[*configv1alpha1.KwokctlComponent],
Marshal: marshalConfig,
MutateToInternal: mutateToInternalConfig(internalversion.ConvertToInternalKwokctlComponent),
MutateToVersiond: mutateToVersiondConfig(internalversion.ConvertToV1alpha1KwokctlComponent),
},
v1alpha1.StageKind: {
Unmarshal: unmarshalConfig[*v1alpha1.Stage],
Marshal: marshalConfig,
Expand Down
25 changes: 25 additions & 0 deletions pkg/kwokctl/cmd/create/cluster/cluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ import (
"sigs.k8s.io/kwok/pkg/log"
"sigs.k8s.io/kwok/pkg/utils/kubeconfig"
"sigs.k8s.io/kwok/pkg/utils/path"
"sigs.k8s.io/kwok/pkg/utils/slices"
)

type flagpole struct {
Expand All @@ -42,6 +43,9 @@ type flagpole struct {
Kubeconfig string
ExtraArgs []string

ComponentArgs []string
EnableComponents []string

*internalversion.KwokctlConfiguration
}

Expand Down Expand Up @@ -145,6 +149,9 @@ func NewCommand(ctx context.Context) *cobra.Command {
cmd.Flags().Float64Var(&flags.Options.HeartbeatFactor, "heartbeat-factor", flags.Options.HeartbeatFactor, "Scale factor for all about heartbeat")
cmd.Flags().StringArrayVar(&flags.ExtraArgs, "extra-args", flags.ExtraArgs, "Pass a single extra arg key-value pair to the component in the format `component=key=value`")

cmd.Flags().StringArrayVar(&flags.ComponentArgs, "component-args", flags.ComponentArgs, "Set component args for the cluster, format: .key1=value1 .key2=value2")
cmd.Flags().StringArrayVar(&flags.EnableComponents, "enable-components", flags.EnableComponents, "Enable components for the cluster")

return cmd
}

Expand Down Expand Up @@ -286,6 +293,24 @@ func runE(ctx context.Context, flags *flagpole) error {
cleanUp()
return err
}

// Enable components
for _, componentName := range flags.EnableComponents {
componentPrefix := fmt.Sprintf(".%s.", componentName)
args := slices.FilterAndMap(flags.ComponentArgs, func(s string) (string, bool) {
if !strings.HasPrefix(s, componentPrefix) {
return "", false
}
return s[len(componentPrefix)-1:], true
})
err := rt.SetComponents(ctx, componentName, args...)
if err != nil {
logger.Error("Failed to set components", err, "component", componentName)
cleanUp()
return err
}
}

err = rt.Save(ctx)
if err != nil {
logger.Error("Failed to save config", err)
Expand Down
26 changes: 26 additions & 0 deletions pkg/kwokctl/components/utils.go
Original file line number Diff line number Diff line change
Expand Up @@ -89,3 +89,29 @@ var (
func GetRuntimeMode(runtime string) string {
return runtimeTypeMap[runtime]
}

// PatchComponent patches a component.
func PatchComponent(c internalversion.Component, patch internalversion.ComponentPatches) internalversion.Component {
for _, a := range patch.ExtraArgs {
c.Args = append(c.Args, fmt.Sprintf("--%s=%s", a.Key, a.Value))
}

for _, v := range patch.ExtraVolumes {
c.Volumes = append(c.Volumes, internalversion.Volume{
Name: v.Name,
HostPath: v.HostPath,
PathType: v.PathType,
MountPath: v.MountPath,
ReadOnly: v.ReadOnly,
})
}

for _, e := range patch.ExtraEnvs {
c.Envs = append(c.Envs, internalversion.Env{
Name: e.Name,
Value: e.Value,
})
}

return c
}
Loading

0 comments on commit 8e29a06

Please sign in to comment.