Skip to content
This repository has been archived by the owner on Aug 12, 2024. It is now read-only.

Provide validation tooling for plain bundles #167

Open
exdx opened this issue Mar 24, 2022 · 4 comments
Open

Provide validation tooling for plain bundles #167

exdx opened this issue Mar 24, 2022 · 4 comments
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Milestone

Comments

@exdx
Copy link
Member

exdx commented Mar 24, 2022

The plain bundle format is relatively straightforward and documented in #149. Even though it's very intuitive, it's still useful to be able to provide users of the format with some sort of static validation tooling to ensure that their bundle is valid and can successfully be applied to the cluster. Based on the plain+v0 bundle spec the tooling would do the following:

  • Confirm the bundle source is reachable
  • Confirm every file in the /manifests directory (image-based bundles) or user-provided directory (git-based bundles) is a valid YAML manifest that can be applied via a Kubernetes client successfully
  • Confirm no extra, non-manifest files are included
  • Confirm at least one file exists in the directory provided
@exdx exdx added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label Mar 24, 2022
@exdx exdx added this to the backlog milestone Mar 24, 2022
@exdx
Copy link
Member Author

exdx commented Mar 31, 2022

0.4-0.5 candidate

asmacdo added a commit to asmacdo/rukpak that referenced this issue Aug 16, 2022
Fixes operator-framework#167

Signed-off-by: Austin Macdonald <austin@redhat.com>
asmacdo added a commit to asmacdo/rukpak that referenced this issue Aug 16, 2022
Closes operator-framework#167

Signed-off-by: Austin Macdonald <austin@redhat.com>
@asmacdo
Copy link
Member

asmacdo commented Aug 23, 2022

Confirm every file in the /manifests directory (image-based bundles) or user-provided directory (git-based bundles) is a valid YAML manifest that can be applied via a Kubernetes client successfully

We can easily confirm that each file is valid yaml, but confirming that the manifest can be applied to Kubernetes is more complex. I discussed this with folks and @kevinrizza pointed out that at validation time, some kubernetes manifests may NOT be able to be applied because the relevent CRDs are not yet present on cluster.

For initial implementation, I am going to check "valid yaml or json" but not check "applicable via a Kubernetes client".

If we need to check for valid k8s manifests, lets file a new issue.

asmacdo added a commit to asmacdo/rukpak that referenced this issue Aug 23, 2022
Fixes operator-framework#167

Signed-off-by: Austin Macdonald <austin@redhat.com>
asmacdo added a commit to asmacdo/rukpak that referenced this issue Aug 23, 2022
Closes operator-framework#167

Signed-off-by: Austin Macdonald <austin@redhat.com>
asmacdo added a commit to asmacdo/rukpak that referenced this issue Aug 25, 2022
Closes operator-framework#167

Signed-off-by: Austin Macdonald <austin@redhat.com>
asmacdo added a commit to asmacdo/rukpak that referenced this issue Aug 29, 2022
Initialize and validate plain bundles using the cli-runtime library.

Closes operator-framework#167

Signed-off-by: Austin Macdonald <austin@redhat.com>
asmacdo added a commit to asmacdo/rukpak that referenced this issue Aug 29, 2022
Initialize and validate plain bundles using the cli-runtime library.

Closes operator-framework#167

Signed-off-by: Austin Macdonald <austin@redhat.com>
asmacdo added a commit to asmacdo/rukpak that referenced this issue Oct 3, 2022
Initialize and validate plain bundles using the cli-runtime library.

Closes operator-framework#167

Signed-off-by: Austin Macdonald <austin@redhat.com>
@github-actions
Copy link

This issue has become stale because it has been open 60 days with no activity. The maintainers of this repo will remove this label during issue triage or it will be removed automatically after an update. Adding the lifecycle/frozen label will cause this issue to ignore lifecycle events.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 23, 2022
@asmacdo asmacdo removed their assignment Jan 24, 2023
@github-actions github-actions bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 25, 2023
@github-actions
Copy link

This issue has become stale because it has been open 60 days with no activity. The maintainers of this repo will remove this label during issue triage or it will be removed automatically after an update. Adding the lifecycle/frozen label will cause this issue to ignore lifecycle events.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Mar 26, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants