Add YAML sample CRD extension by rhamilto · Pull Request #2889 · openshift/console

rhamilto · 2019-10-02T21:04:05Z

Resolves https://jira.coreos.com/browse/CONSOLE-1800

Note: I refactored the styles for the samples a bit to better maintain the visual hierarchy and align the samples with the schema contents. As a bonus, now more samples are visible.

WIP ConsoleYAMLSample CRD:

apiVersion: apiextensions.k8s.io/v1beta1
kind: CustomResourceDefinition
metadata:
  name: consoleyamlsamples.console.openshift.io
  annotations:
    displayName: ConsoleYAMLSample
    description: Extension for configuring openshift web console YAML samples.
spec:
  scope: Cluster
  group: console.openshift.io
  versions:
  - name: v1
    served: true
    storage: true
  names:
    plural: consoleyamlsamples
    singular: consoleyamlsample
    kind: ConsoleYAMLSample
    listKind: ConsoleYAMLSampleList
  additionalPrinterColumns:
  - name: Title
    type: string
    JSONPath: .spec.title
  - name: Age
    type: string
    JSONPath: .metadata.creationTimestamp
  - name: Description
    type: string
    JSONPath: .spec.description
  subresources:
    status: {}
  validation:
    openAPIV3Schema:
      properties:
        spec:
          type: object
          description: Represents console YAML sample spec
          required:
          - targetResource
          - title
          - description
          - yaml
          properties:
            targetResource:
              type: object
              description: TBD
              required:
                - apiVersion
                - kind
              properties:
                apiVersion:
                  type: string
                  description: TBD
                kind:
                  type: string
                  description: TBD
            title:
              type: string
              description: Title of the YAML sample
            description:
              type: string
              description: Description of the YAML sample
            yaml:
              type: string
              description: The sample YAML

rhamilto · 2019-10-03T15:34:49Z

@sg00dwin: note these buttons have been migrated (they've been moved here from frontend/public/components/sidebars/resource-sidebar.jsx)

rhamilto · 2019-10-03T15:35:40Z

@sg00dwin: no need to migrate these buttons (note they've been moved to frontend/public/components/sidebars/resource-sidebar-samples.tsx)

spadgett · 2019-10-04T12:15:30Z

I don't have a great suggestion here, but I worry that having apiVersion repeated will be confusing. Maybe we want something like this to make it more clear.

spec: targetResource: apiVersion: batch/v1 kind: Job yaml: ...

Makes sensto to me :+1

So do we want to go with @spadgett's proposal for targetResource?

Added in 4efb01f2814fd1ce08d3f1062e517d6c18231cc7. Will drop the commit if we decide against.

Yeah, this was added in the openshift/api pr: https://github.com/openshift/api/pull/465/files#diff-8581d44cd64acbd596e8f8d3ffb43608R23

rhamilto

Comments addressed. @spadgett, please take another look.

spadgett · 2019-10-08T17:00:34Z

Suggested change

const existingSamples = !_.isEmpty(defaultSamples.get(referenceForModel(kindObj)))

const existingSamples = defaultSamples.get(referenceForModel(kindObj)) || [];

spadgett

/lgtm

spadgett · 2019-10-17T19:37:38Z

Removing WIP as the CRD is now available

spadgett · 2019-10-17T19:54:22Z

/lgtm

openshift-ci-robot · 2019-10-17T19:54:34Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rhamilto, spadgett

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~frontend/OWNERS~~ [rhamilto,spadgett]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

openshift-ci-robot · 2019-10-17T19:54:34Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: rhamilto, spadgett

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details

Needs approval from an approver in each of these files:

~~frontend/OWNERS~~ [rhamilto,spadgett]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

spadgett · 2019-10-17T20:07:21Z

/retest

rhamilto · 2019-10-17T21:10:03Z

/retest

rhamilto · 2019-10-17T21:14:27Z

/retest

openshift-bot · 2019-10-18T07:25:28Z

/retest

Please review the full test history for this PR and help us cut down flakes.

rhamilto · 2019-10-18T13:23:08Z

/retest

spadgett · 2019-10-18T14:50:06Z

/refresh

spadgett · 2019-10-18T14:50:24Z

/test e2e-gcp-console

rhamilto · 2019-10-18T17:22:12Z

/retest

openshift-ci-robot · 2019-10-18T18:27:19Z

@rhamilto: The following test failed, say /retest to rerun them all:

Test name	Commit	Details	Rerun command
ci/prow/e2e-aws-console	7857bdfe71bac72a0ca15b7d7c3d3bd4fc074c73	link	`/test e2e-aws-console`

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

rhamilto · 2019-10-18T18:31:28Z

/retest

openshift-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. component/core Related to console core functionality labels Oct 2, 2019

openshift-ci-robot requested review from dtaylor113 and kyoto October 2, 2019 21:04

openshift-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 2, 2019

rhamilto force-pushed the yaml-example branch 4 times, most recently from 3becc78 to db3ca6a Compare October 3, 2019 14:14

rhamilto commented Oct 3, 2019

View reviewed changes

Comment thread frontend/public/models/yaml-templates.ts Outdated

rhamilto commented Oct 3, 2019

View reviewed changes

rhamilto force-pushed the yaml-example branch from db3ca6a to 5fdf145 Compare October 3, 2019 20:35

spadgett requested changes Oct 4, 2019

View reviewed changes

spadgett added this to the v4.3 milestone Oct 4, 2019

rhamilto force-pushed the yaml-example branch from 5fdf145 to 837d741 Compare October 7, 2019 19:12

rhamilto commented Oct 7, 2019

View reviewed changes

rhamilto force-pushed the yaml-example branch from 837d741 to 35b0f91 Compare October 7, 2019 19:56

spadgett reviewed Oct 8, 2019

View reviewed changes

rhamilto force-pushed the yaml-example branch 2 times, most recently from 0522827 to 274df8b Compare October 9, 2019 12:26

jhadvig mentioned this pull request Oct 11, 2019

Add ConsoleYAMLSample CRD as part of the console extensions openshift/cluster-config-operator#99

Closed

rhamilto force-pushed the yaml-example branch from 274df8b to 7857bdf Compare October 16, 2019 15:32

rhamilto mentioned this pull request Oct 16, 2019

Metrics and Resource-sidebar updated to pf4 Button component #2967

Merged

rhamilto force-pushed the yaml-example branch 2 times, most recently from 4efb01f to 572d738 Compare October 16, 2019 18:55

spadgett reviewed Oct 16, 2019

View reviewed changes

Comment thread frontend/public/components/sidebars/resource-sidebar-samples.tsx Outdated

Add YAML sample CRD extension

3a562b1

rhamilto force-pushed the yaml-example branch from 572d738 to 3a562b1 Compare October 16, 2019 19:49

spadgett approved these changes Oct 17, 2019

View reviewed changes

openshift-ci-robot assigned spadgett Oct 17, 2019

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 17, 2019

spadgett changed the title ~~[WIP] Add YAML sample CRD extension~~ Add YAML sample CRD extension Oct 17, 2019

openshift-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 17, 2019

Align out-of-the-box sidebar samples with custom resource

e2d3920

spadgett force-pushed the yaml-example branch from c325382 to e2d3920 Compare October 17, 2019 19:54

openshift-ci-robot removed the lgtm Indicates that a PR is ready to be merged. label Oct 17, 2019

openshift-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 17, 2019

openshift-merge-robot merged commit 3ab9092 into openshift:master Oct 18, 2019

rhamilto deleted the yaml-example branch October 21, 2019 13:00

	const existingSamples = !_.isEmpty(defaultSamples.get(referenceForModel(kindObj)))
	const existingSamples = defaultSamples.get(referenceForModel(kindObj)) \|\| [];

Conversation

rhamilto commented Oct 2, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

rhamilto Oct 3, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rhamilto Oct 3, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

spadgett Oct 4, 2019

Choose a reason for hiding this comment

Uh oh!

jhadvig Oct 14, 2019

Choose a reason for hiding this comment

Uh oh!

rhamilto Oct 16, 2019

Choose a reason for hiding this comment

Uh oh!

rhamilto Oct 16, 2019

Choose a reason for hiding this comment

Uh oh!

spadgett Oct 16, 2019

Choose a reason for hiding this comment

Uh oh!

rhamilto left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

spadgett Oct 8, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

spadgett left a comment

Choose a reason for hiding this comment

Uh oh!

spadgett commented Oct 17, 2019

Uh oh!

spadgett commented Oct 17, 2019

Uh oh!

openshift-ci-robot commented Oct 17, 2019

Uh oh!

openshift-ci-robot commented Oct 17, 2019

Uh oh!

spadgett commented Oct 17, 2019

Uh oh!

rhamilto commented Oct 17, 2019

Uh oh!

rhamilto commented Oct 17, 2019

Uh oh!

openshift-bot commented Oct 18, 2019

Uh oh!

rhamilto commented Oct 18, 2019

Uh oh!

spadgett commented Oct 18, 2019

Uh oh!

spadgett commented Oct 18, 2019

Uh oh!

rhamilto commented Oct 18, 2019

Uh oh!

openshift-ci-robot commented Oct 18, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rhamilto commented Oct 18, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

rhamilto commented Oct 2, 2019 •

edited

Loading

rhamilto Oct 3, 2019 •

edited

Loading

openshift-ci-robot commented Oct 18, 2019 •

edited

Loading