diff --git a/api/v1beta1/virtualdc_types.go b/api/v1beta1/virtualdc_types.go index f8ed8f7..f0d6a69 100644 --- a/api/v1beta1/virtualdc_types.go +++ b/api/v1beta1/virtualdc_types.go @@ -23,21 +23,21 @@ import ( // VirtualDCSpec defines the desired state of VirtualDC type VirtualDCSpec struct { - // Neco branch is a target branch name for dctest + // Neco branch to use for dctest. // If this field is empty, controller runs dctest with "main" branch //+kubebuiler:validation:Optional NecoBranch string `json:"necoBranch,omitempty"` - // Neco apps branch is a target branch name for dctest + // Neco-apps branch to use for dctest. // If this field is empty, controller runs dctest with "main" branch //+kubebuiler:validation:Optional NecoAppsBranch string `json:"necoAppsBranch,omitempty"` - // Skip bootstrap of neco apps if this is true + // Skip bootstrapping neco-apps if true //+kubebuilder:validation:Optional SkipNecoApps bool `json:"skipNecoApps,omitempty"` - // Command is run after creating dctest pods + // Path to a user-defined script and its arguments to run after bootstrapping dctest //+kubebuiler:validation:Optional Command []string `json:"command,omitempty"` diff --git a/config/crd/bases/nyamber.cybozu.io_autovirtualdcs.yaml b/config/crd/bases/nyamber.cybozu.io_autovirtualdcs.yaml index ca91be2..c5334b7 100644 --- a/config/crd/bases/nyamber.cybozu.io_autovirtualdcs.yaml +++ b/config/crd/bases/nyamber.cybozu.io_autovirtualdcs.yaml @@ -65,19 +65,18 @@ spec: description: VirtualDCSpec defines the desired state of VirtualDC properties: command: - description: Command is run after creating dctest pods + description: Path to a user-defined script and its arguments + to run after bootstrapping dctest items: type: string type: array necoAppsBranch: - description: Neco apps branch is a target branch name for - dctest If this field is empty, controller runs dctest with - "main" branch + description: Neco-apps branch to use for dctest. If this field + is empty, controller runs dctest with "main" branch type: string necoBranch: - description: Neco branch is a target branch name for dctest - If this field is empty, controller runs dctest with "main" - branch + description: Neco branch to use for dctest. If this field + is empty, controller runs dctest with "main" branch type: string resources: description: ResourceRequirements describes the compute resource @@ -130,7 +129,7 @@ spec: type: object type: object skipNecoApps: - description: Skip bootstrap of neco apps if this is true + description: Skip bootstrapping neco-apps if true type: boolean type: object status: diff --git a/config/crd/bases/nyamber.cybozu.io_virtualdcs.yaml b/config/crd/bases/nyamber.cybozu.io_virtualdcs.yaml index 8687c77..c6b6879 100644 --- a/config/crd/bases/nyamber.cybozu.io_virtualdcs.yaml +++ b/config/crd/bases/nyamber.cybozu.io_virtualdcs.yaml @@ -47,17 +47,18 @@ spec: description: VirtualDCSpec defines the desired state of VirtualDC properties: command: - description: Command is run after creating dctest pods + description: Path to a user-defined script and its arguments to run + after bootstrapping dctest items: type: string type: array necoAppsBranch: - description: Neco apps branch is a target branch name for dctest If - this field is empty, controller runs dctest with "main" branch + description: Neco-apps branch to use for dctest. If this field is + empty, controller runs dctest with "main" branch type: string necoBranch: - description: Neco branch is a target branch name for dctest If this - field is empty, controller runs dctest with "main" branch + description: Neco branch to use for dctest. If this field is empty, + controller runs dctest with "main" branch type: string resources: description: ResourceRequirements describes the compute resource requirements. @@ -107,7 +108,7 @@ spec: type: object type: object skipNecoApps: - description: Skip bootstrap of neco apps if this is true + description: Skip bootstrapping neco-apps if true type: boolean type: object status: diff --git a/docs/crd_virtualdc.md b/docs/crd_virtualdc.md index 0d3378e..d6ce79c 100644 --- a/docs/crd_virtualdc.md +++ b/docs/crd_virtualdc.md @@ -38,10 +38,10 @@ VirtualDCSpec defines the desired state of VirtualDC | Field | Description | Scheme | Required | | ----- | ----------- | ------ | -------- | -| necoBranch | Neco branch is a target branch name for dctest If this field is empty, controller runs dctest with \"main\" branch | string | false | -| necoAppsBranch | Neco apps branch is a target branch name for dctest If this field is empty, controller runs dctest with \"main\" branch | string | false | -| skipNecoApps | Skip bootstrap of neco apps if this is true | bool | false | -| command | Command is run after creating dctest pods | []string | false | +| necoBranch | Neco branch to use for dctest. If this field is empty, controller runs dctest with \"main\" branch | string | false | +| necoAppsBranch | Neco-apps branch to use for dctest. If this field is empty, controller runs dctest with \"main\" branch | string | false | +| skipNecoApps | Skip bootstrapping neco-apps if true | bool | false | +| command | Path to a user-defined script and its arguments to run after bootstrapping dctest | []string | false | | resources | | corev1.ResourceRequirements | false | [Back to Custom Resources](#custom-resources)