Merge pull request operator-framework#426 from alecmerdler/action-des…

…criptors

Action Descriptors

deploy/chart/templates/03-clusterserviceversion.crd.yaml

@@ -282,6 +282,33 @@ spec:
                             value:
                               type: object
                               description: If present, the value of this spec is the same for all instances of the CRD and can be found here instead of on the CR.
+                      actionDescriptors:
+                        type: array
+                        items:
+                          type: object
+                          description: A spec for actions that can be performed on instances of the CRD
+                          required:
+                            - path
+                            - displayName
+                            - description
+                          properties:
+                            path:
+                              type: string
+                              description: A jsonpath indexing into the spec object on the CR where the the spec value can be found.
+                            displayName:
+                              type: string
+                              description: A human-readable name for the action.
+                            description:
+                              type: string
+                              description: A description of the action.
+                            x-descriptors:
+                              type: array
+                              description: A list of descriptors for the action that indicate the meaning of the action.
+                              items:
+                                type: string
+                            value:
+                              type: object
+                              description: If present, the value of this action is the same for all instances of the CRD and can be found here instead of on the CR.
                 required:
                   type: array
                   description: What resources this operator is responsible for managing. No two running operators should manage the same resource.

pkg/api/apis/operators/v1alpha1/clusterserviceversion_types.go

@@ -41,6 +41,15 @@ type SpecDescriptor struct {
 	Value        *json.RawMessage `json:"value,omitempty"`
 }
 
+// ActionDescriptor describes a declarative action that can be performed on a custom resource instance
+type ActionDescriptor struct {
+	Path         string           `json:"path"`
+	DisplayName  string           `json:"displayName,omitempty"`
+	Description  string           `json:"description,omitempty"`
+	XDescriptors []string         `json:"x-descriptors,omitempty"`
+	Value        *json.RawMessage `json:"value,omitempty"`
+}
+
 // CRDDescription provides details to ALM about the CRDs
 type CRDDescription struct {
 	Name              string                 `json:"name"`
@@ -51,6 +60,7 @@ type CRDDescription struct {
 	Resources         []CRDResourceReference `json:"resources,omitempty"`
 	StatusDescriptors []StatusDescriptor     `json:"statusDescriptors,omitempty"`
 	SpecDescriptors   []SpecDescriptor       `json:"specDescriptors,omitempty"`
+	ActionDescriptor  []ActionDescriptor     `json:"actionDescriptors,omitempty"`
 }
 
 // CRDResourceReference is a Kubernetes resource type used by a custom resource