Add alm-examples-metadata

[Jamstah]

This is a suggested solution to be able to add extended metadata to the alm-examples. It is intended to start a discussion about how this data could be stored, so feel free to say if there's a better way that exists/could exist that I don't know because I'm fairly new to operators.

I'm also not sure that this is the official spec for CSVs, but I couldn't find a better alternative. That could be my poor google skills :)

Add extended metadata for alm-examples to be able to extend the capabilities of UI creating CRs. Can be used to identify, for example, different backend technologies (eg storage), different HA options, different deployment sizes (small, medium, large, or example workload based sizings)

Description of the change:

Add new field for alm-examples-metadata.

Motivation for the change:

We are writing a UI to create PRs based on CRDs and associated CSV data. We want to be able to desribe the example CRs in more detail to the end user, and feel that the right place to store the data is in the CSV alongside the examples

Reviewer Checklist

• Implementation matches the proposed design, or proposal is updated to match implementation
• Sufficient unit test coverage
• Sufficient end-to-end test coverage
• Docs updated or added to /docs
• Commit messages sensible and descriptive

[openshift-ci-robot]

Hi @Jamstah. Thanks for your PR.

I'm waiting for a operator-framework member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

[ecordell]

Thanks for the PR and idea!

We have been considering something along the lines of this ConsoleYamlSample CRD instead of annotations: https://github.com/openshift/api/blob/master/console/v1/0000_10_consoleyamlsample.crd.yaml

Would something like that address your UI needs as well? The annotation is fine, but the existing alm-examples is a bit unwieldy, and this seems to continue in that direction.

[Jamstah]

I think that would work for us, but it raises questions:

• How are the samples created, are they installed with the operator?
• What loads the sample CRD, is that with the openshift console operator?
• This seems to move data away from the CSV and into an openshift console specific thing. I suggested the annotation here to keep it together, and support non-openshift clusters. Although I 100% agree this method is unwieldy as is!

[chrisbygrave]

We agree that the existing alm-examples gets unwieldy at scale, and we're interested to work together on something better.

In the meantime, we'd still like to pursue the peer annotation alm-examples-metadata as a stop-gap. We envision this taking the format:

alm-examples

[{
   metadata: {
      name: 'alm-example-1'
   }
}, {
   metadata: {
      name: 'alm-example-2'
   }
}]

alm-examples-metadata

{
   'example-name-1': {
      description: 'something about example-name-1',
      foo: 'some other arbitrary metadata, such as sizing content'
   },
   'example-name-2': {
      description: 'something about example-name-2',
      foo: 'some other arbitrary metadata, such as sizing content'
   }
}

So, the metadata annotation is a hash, keyed of the example name. This requires each example requiring unique metadata to have a unique name. The reason for this being a hash is that the metadata annotation has no need to know the ordering of the examples header (which is not something SDK users have direct control of)

[ecordell]

This seems reasonable as a stopgap, and is only documentation.

/lgtm

[openshift-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ecordell, Jamstah

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

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [ecordell]

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

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[openshift-bot]

/retest

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

[openshift-ci-robot]

@openshift-bot: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest

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

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.

[njhale]

/ok-to-test

Wow, that's some hot-loop.

[openshift-bot]

/retest

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

[openshift-bot]

/retest

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

[openshift-bot]

/retest

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

[openshift-bot]

/retest

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

[openshift-bot]

/retest

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

[openshift-bot]

/retest

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

[openshift-bot]

/retest

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

[openshift-bot]

/retest

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

[openshift-bot]

/retest

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

[openshift-bot]

/retest

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

[openshift-bot]

/retest

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