qs.yaml

apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: quickstarts.console.openshift.io
  annotations:
    displayName: QuickStarts
    description: Extension for adding Quick Starts to the OpenShift web console
spec:
  scope: Cluster
  preserveUnknownFields: false
  group: console.openshift.io
  versions:
  - name: v1
    served: true
    storage: true
  names:
    plural: quickstarts
    singular: quickstart
    kind: QuickStart
    listKind: QuickStartList
  additionalPrinterColumns:
  - name: Display name
    type: string
    JSONPath: .spec.displayName
  - name: Description
    type: string
    JSONPath: .spec.description
  - name: Age
    type: date
    JSONPath: .metadata.creationTimestamp
  subresources:
    status: {}
  validation:
    openAPIV3Schema:
      description: QuickStart is an extension for guiding user thought various workflows in the OpenShift web console
        links.
      type: object
      required:
      - spec
      properties:
        apiVersion:
          description: 'APIVersion defines the versioned schema of this representation
            of an object. Servers should convert recognized schemas to the latest
            internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources'
          type: string
        kind:
          description: 'Kind is a string value representing the REST resource this
            object represents. Servers may infer this from the endpoint the client
            submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
          type: string
        metadata:
          type: object
        spec:
          description: QuickStartSpec is the desired quick start configuration.
          type: object
          required:
          - displayName
          - introduction
          - tasks
          properties:
            displayName:
              description: displayName is the display name of the Quick Start.
              type: string
            icon:
              description: icon is a base64 encoded image that are used as Quick Start's icon. (optional)
              type: string
            tags:
              description: tags is an array of strings that describe the Quick Start. (optional)
              type: array
              items:
                type: string
            duration:
              description: duration informs user on aproximately how long the
                Quick Start should take to finish. (optional)
              type: integer
            description:
              description: description is the description of the Quick Start. (optional, includes markdown)
              type: string
            prerequisites:
              description: prerequisites contains a list prerequisites for the Quick Start. (optional)
              type: array
              items:
                type: string
            introduction:
              description: introduction describes the purpose and usability of
                the Quick Start. (includes markdown)
              type: string
            tasks:
              type: array
              items:
                type: object
                required:
                - title
                - description
                properties:
                  title:
                    description: title describes the given task and will be rendered as a step header.
                    type: string
                  description:
                    description: description contains steps necessary to pass the task. (includes markdown)
                    type: string
                  review:
                    description: review contains instructions that validate taken. Based on the outcome of the review
                      steps user will have to select 'Yes' or 'No' radio button, which indicates whether the step was
                      passed succesfully or unsuccesfully. (optional)
                    type: object
                    items:
                    required:
                    - instructions
                    - taskHelp
                    properties:
                      instructions:
                        description: instructions contains steps that user needs to take in order to validate his work after
                          going through a task.(includes markdown)
                        type: string
                      taskHelp:
                        description: taskHelp contains suggestion with how to deal with failed task review and will
                          will be rendered at the end of task.
                        type: string
                  recapitulation:
                    description: recapitulation contains information about passed step.
                    type: object
                    required:
                    - success
                    - failed
                    properties:
                      success:
                        description: success recapitulates the succesfully passed task.
                        type: string
                      failed:
                        description: failed recapitulates the unsuccessfully passed task.
                        type: string
              conclusion:
                description: conclusion sums up the Quick Start and suggests the possible
                  next Quick Starts for user to take. (optional, includes markdown)
                type: string
              nextQuickStart:
                description: nextQuickStart is the name of the following Quick Start.
                type: string
            accessReviewResources:
              type: array
              items:
                type: object
                required:
                - resource
                - verb
                properties:
                  resource:
                    description: resource is the name of the resource that user's access should be reviewed against
                    type: string
                  verb:
                    description: verb is one of create, get, list, update, patch, delete, deletecollection, watch
                      actions that user's access should be reviewed against
                    type: string
                    pattern: ^create|get|list|update|patch|delete|deletecollection|watch$
                  name:
                    description: name is the nameof the resource instance that user's access should be reviewed against
                    type: string
                  namespace: 
                    description: namespace is the name of the namespace that user's access should be reviewed against
                    type: string
                  group: 
                    description: group is the API group of the resource that user's access should be reviewed against
                    type: string
                  subresource: 
                    description: subresource is one of the existing resource types that user's access should be reviewed against
                    type: string