apiVersion

string

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

kind

string

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

metadata

ObjectMeta

Standard object’s metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

spec

object

ConsoleQuickStartSpec is the desired quick start configuration.

accessReviewResources

array

accessReviewResources contains a list of resources that the user’s access will be reviewed against in order for the user to complete the Quick Start. The Quick Start will be hidden if any of the access reviews fail.

accessReviewResources[]

object

ResourceAttributes includes the authorization attributes available for resource requests to the Authorizer interface

conclusion

string

conclusion sums up the Quick Start and suggests the possible next steps. (includes markdown)

description

string

description is the description of the Quick Start. (includes markdown)

displayName

string

displayName is the display name of the Quick Start.

durationMinutes

integer

durationMinutes describes approximately how many minutes it will take to complete the Quick Start.

icon

string

icon is a base64 encoded image that will be displayed beside the Quick Start display name. The icon should be an vector image for easy scaling. The size of the icon should be 40x40.

introduction

string

introduction describes the purpose of the Quick Start. (includes markdown)

nextQuickStart

array (string)

nextQuickStart is a list of the following Quick Starts, suggested for the user to try.

prerequisites

array (string)

prerequisites contains all prerequisites that need to be met before taking a Quick Start. (includes markdown)

tags

array (string)

tags is a list of strings that describe the Quick Start.

tasks

array

tasks is the list of steps the user has to perform to complete the Quick Start.

tasks[]

object

ConsoleQuickStartTask is a single step in a Quick Start.

group

string

Group is the API Group of the Resource. ““ means all.

name

string

Name is the name of the resource being requested for a “get” or deleted for a “delete”. “” (empty) means all.

namespace

string

Namespace is the namespace of the action being requested. Currently, there is no distinction between no namespace and all namespaces “” (empty) is defaulted for LocalSubjectAccessReviews “” (empty) is empty for cluster-scoped resources “” (empty) means “all” for namespace scoped resources from a SubjectAccessReview or SelfSubjectAccessReview

resource

string

Resource is one of the existing resource types. ““ means all.

subresource

string

Subresource is one of the existing resource types. “” means none.

verb

string

Verb is a kubernetes resource API verb, like: get, list, watch, create, update, delete, proxy. ““ means all.

version

string

Version is the API Version of the Resource. ““ means all.

description

string

description describes the steps needed to complete the task. (includes markdown)

review

object

review contains instructions to validate the task is complete. The user will select ‘Yes’ or ‘No’. using a radio button, which indicates whether the step was completed successfully.

summary

object

summary contains information about the passed step.

title

string

title describes the task and is displayed as a step heading.

failedTaskHelp

string

failedTaskHelp contains suggestions for a failed task review and is shown at the end of task. (includes markdown)

instructions

string

instructions contains steps that user needs to take in order to validate his work after going through a task. (includes markdown)

failed

string

failed briefly describes the unsuccessfully passed task. (includes markdown)

success

string

success describes the succesfully passed task.

200 - OK

Status schema

401 - Unauthorized

Empty

200 - OK

ConsoleQuickStartList schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

ConsoleQuickStart schema

200 - OK

ConsoleQuickStart schema

201 - Created

ConsoleQuickStart schema

202 - Accepted

ConsoleQuickStart schema

401 - Unauthorized

Empty

name

string

name of the ConsoleQuickStart

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

200 - OK

Status schema

202 - Accepted

Status schema

401 - Unauthorized

Empty

200 - OK

ConsoleQuickStart schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

200 - OK

ConsoleQuickStart schema

401 - Unauthorized

Empty

dryRun

string

When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

fieldValidation

string

fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

body

ConsoleQuickStart schema

200 - OK

ConsoleQuickStart schema

201 - Created

ConsoleQuickStart schema

401 - Unauthorized

Empty