github.com/kubevela/workflow@v0.6.0/pkg/stdlib/actions/v1/pkgs/kube.cue (about)

     1  #Apply: {
     2  	#do:       "apply"
     3  	#provider: "kube"
     4  
     5  	// +usage=The cluster to use
     6  	cluster: *"" | string
     7  	// +usage=The resource to apply
     8  	value: {...}
     9  	// +usage=The patcher that will be applied to the resource, you can define the strategy of list merge through comments. Reference doc here: https://kubevela.io/docs/platform-engineers/traits/patch-trait#patch-in-workflow-step
    10  	patch?: {...}
    11  	...
    12  }
    13  
    14  #Patch: {
    15  	#do:       "patch"
    16  	#provider: "kube"
    17  
    18  	// +usage=The cluster to use
    19  	cluster: *"" | string
    20  	// +usage=The resource to patch, we'll first get the resource from the cluster, then apply the patcher to it
    21  	value: {...}
    22  	// +usage=The patcher that will be applied to the resource, you can define the strategy of list merge through comments. Reference doc here: https://kubevela.io/docs/platform-engineers/traits/patch-trait#patch-in-workflow-step
    23  	patch: {...}
    24  	// +usage=The resource after applied will be filled in this field after the action is executed
    25  	result?: {...}
    26  	...
    27  }
    28  
    29  #ApplyInParallel: {
    30  	#do:       "apply-in-parallel"
    31  	#provider: "kube"
    32  
    33  	// +usage=The cluster to use
    34  	cluster: *"" | string
    35  	// +usage=The resources to apply in parallel
    36  	value: [...{...}]
    37  	...
    38  }
    39  
    40  #Read: {
    41  	#do:       "read"
    42  	#provider: "kube"
    43  
    44  	// +usage=The cluster to use
    45  	cluster: *"" | string
    46  	// +usage=The resource to read, this field will be filled with the resource read from the cluster after the action is executed
    47  	value?: {...}
    48  	...
    49  }
    50  
    51  #List: {
    52  	#do:       "list"
    53  	#provider: "kube"
    54  
    55  	// +usage=The cluster to use
    56  	cluster: *"" | string
    57  	// +usage=The resource to list
    58  	resource: {
    59  		// +usage=The api version of the resource
    60  		apiVersion: string
    61  		// +usage=The kind of the resource
    62  		kind: string
    63  	}
    64  	// +usage=The filter to list the resources
    65  	filter?: {
    66  		// +usage=The namespace to list the resources
    67  		namespace?: *"" | string
    68  		// +usage=The label selector to filter the resources
    69  		matchingLabels?: {...}
    70  	}
    71  	// +usage=The listed resources will be filled in this field after the action is executed
    72  	list?: {...}
    73  	...
    74  }
    75  
    76  #Delete: {
    77  	#do:       "delete"
    78  	#provider: "kube"
    79  
    80  	// +usage=The cluster to use
    81  	cluster: *"" | string
    82  	// +usage=The resource to delete
    83  	value: {
    84  		// +usage=The api version of the resource
    85  		apiVersion: string
    86  		// +usage=The kind of the resource
    87  		kind: string
    88  		// +usage=The metadata of the resource
    89  		metadata: {
    90  			// +usage=The name of the resource
    91  			name?: string
    92  			// +usage=The namespace of the resource
    93  			namespace: *"default" | string
    94  		}
    95  	}
    96  	// +usage=The filter to delete the resources
    97  	filter?: {
    98  		// +usage=The namespace to list the resources
    99  		namespace?: string
   100  		// +usage=The label selector to filter the resources
   101  		matchingLabels?: {...}
   102  	}
   103  	...
   104  }