Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

EC-905 - Document input.snapshot in policy.input #2108

Merged
merged 1 commit into from
Oct 25, 2024
Merged

EC-905 - Document input.snapshot in policy.input #2108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion docs/modules/ROOT/pages/policy_input.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ being available. Not all information is available for all images. This is noted
description of each attribute.

It is important to note that this command may proccess multiple images at the same time. In such
cases, a different input is generated for each image. In other words, policy rules only eve have
cases, a different input is generated for each image. In other words, policy rules only ever have
access to the information about a single image.

[,json]
Expand All @@ -29,6 +29,7 @@ access to the information about a single image.
}
],
"image": #ImageDescriptor
"snapshot": #SnapshotDescriptor
}

#ImageDescriptor: {
Expand All @@ -54,6 +55,19 @@ access to the information about a single image.
"url": "<STRING>"
}
}

#SnapshotDescriptor: {
"application": "<STRING>",
"displayName": "<STRING>",
"displayDescription": "<STRING>",
"components": [..."#SnapshotComponentDescriptor"]
}

#SnapshotComponentDescriptor: {
"name": "<STRING>",
"containerImage": "<STRING>",
"source": #SourceDescriptor"
}
----

`.attestations` is an array of objects. Each object contains the `.statement` and the `.signatures`
Expand Down Expand Up @@ -101,3 +115,7 @@ information is not given to the command.
The SourceDescriptor contains the the single `git` attribute which hold an object with information
about a git repository. `.revision` is a string holding a git reference. This could be a commit ID,
branch, etc. `url` is the the URL of the git repository.

The SnapshotDescriptor contains the information about the application snapshot provided to the `ec validate image` command. `.application` is a string holding the name of the application. `.displayName` is a string holding the display name of the application. `.displayDescription` is a string holding the display description of the application. `.components` is an array of SnapshotComponentDescriptor objects.

The SnapshotComponentDescriptor contains the information about the components of the application snapshot provided to the `ec validate image` command. `.name` is a string holding the name of the component. `.containerImage` is a string holding the container image of the component. `.source` is a SourceDescriptor object.
Loading