-
Notifications
You must be signed in to change notification settings - Fork 471
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
138 additions
and
39 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,123 @@ | ||
| apiVersion: apiextensions.k8s.io/v1beta1 | ||
| kind: CustomResourceDefinition | ||
| metadata: | ||
| name: guidedtours.console.openshift.io | ||
| annotations: | ||
| displayName: GuidedTours | ||
| description: Extension for adding Guided Tours to the OpenShift web console | ||
| spec: | ||
| scope: Cluster | ||
| preserveUnknownFields: false | ||
| group: console.openshift.io | ||
| versions: | ||
| - name: v1 | ||
| served: true | ||
| storage: true | ||
| names: | ||
| plural: guidedtours | ||
| singular: guidedtour | ||
| kind: GuidedTour | ||
| listKind: GuidedTourList | ||
| additionalPrinterColumns: | ||
| - name: Display name | ||
| type: string | ||
| JSONPath: .spec.displayName | ||
| - name: Version | ||
| type: string | ||
| JSONPath: .spec.version | ||
| - name: Description | ||
| type: string | ||
| JSONPath: .spec.description | ||
| - name: Age | ||
| type: date | ||
| JSONPath: .metadata.creationTimestamp | ||
| subresources: | ||
| status: {} | ||
| "validation": | ||
| "openAPIV3Schema": | ||
| description: GuidedTour 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: GuidedTourSpec is the desired guided tour configuration. | ||
| type: object | ||
| required: | ||
| - version | ||
| - displayName | ||
| - introduction | ||
| - tasks | ||
| properties: | ||
| version: | ||
| description: version definest the release version of the guided | ||
| tour. Each Guided Tour needs to be versioned, to accuratelly | ||
| reflect the workflow in particular release of OpenShift's web | ||
| console. | ||
| type: string | ||
| pattern: ^4.\d+$ | ||
| displayName: | ||
| description: displayName is the display name of the Guided Tour. | ||
| type: string | ||
| icon: | ||
| description: icon is a base64 encoded icon for a Guided Tour, | ||
| that will be displayed next to the displayName. (optional) | ||
| type: string | ||
| duration: | ||
| description: duration informs user on aproximately how long the | ||
| Guided Tour should take to finish. (optional) | ||
| type: integer | ||
| description: | ||
| description: description is the description of the Guided Tour. (optional, includes markdown) | ||
| type: string | ||
| prerequisites: | ||
| description: prerequisites describes what are the prerequisites | ||
| for the Guided Tour. (optional) | ||
| type: string | ||
| introduction: | ||
| description: introduction describes the purpose and usability of | ||
| the Guided Tour. (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 information and steps that user | ||
| needs to take in order to validate his work, after he goes through a task. | ||
| taskReview will be rendered at the end of task. (optional, includes markdown) | ||
| type: string | ||
| recapitulation: | ||
| description: recapitulation contains information about passed step. (optional) | ||
| type: string | ||
| conclusion: | ||
| description: conclusion sums up the Guided Tour and suggests the possible | ||
| next Guided Tours for user to take. (optional, includes markdown) | ||
| type: string | ||
| nextGuidedTour: | ||
| description: nextGuidedTour is the name of the following Guided Tour. | ||
| type: string |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters