Skip to content

updating docs to explain types of fragments #82

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

Merged
SethHollandsworth merged 1 commit into from
Jan 27, 2025
Merged

updating docs to explain types of fragments #82

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
11 changes: 11 additions & 0 deletions src/confcom/azext_confcom/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
- [allow_unencrypted_scratch](#allow_unencrypted_scratch)
- [allow_capabilities_dropping](#allow_capabilities_dropping)
- [Microsoft Azure CLI 'confcom acifragmentgen' Extension Examples](#microsoft-azure-cli-confcom-acifragmentgen-extension-examples)
- [Types of Policy Fragments](#types-of-policy-fragments)
- [Examples](#examples)
- [Microsoft Azure CLI 'confcom katapolicygen' Extension Examples](#microsoft-azure-cli-confcom-katapolicygen-extension-examples)

## Microsoft Azure CLI 'confcom acipolicygen' Extension Examples
Expand Down Expand Up @@ -665,6 +667,15 @@ Run `az confcom acifragmentgen --help` to see a list of supported arguments alon

For information on what a policy fragment is, see [policy fragments](#policy-fragments). For a full walkthrough on how to generate a policy fragment and use it in a policy, see [Create a Key and Cert for Signing](../samples/certs/README.md).

### Types of Policy Fragments

There are two types of policy fragments:

1. Image-attached fragments: These are fragments that are attached to an image in an ORAS-compliant registry. They are used to provide additional security information about the image and are to be used for a single image. Image-attached fragments are currently in development. Note that nested image-attached fragments are *not* supported.
2. Standalone fragments: These are fragments that are uploaded to an ORAS-compliant registry independent of a specific image and can be used for multiple images. Standalone fragments are currently not supported. Once implemented, nested standalone fragments will be supported.

### Examples

**Examples:**

Example 1: The following command creates a security fragment and prints it to stdout as well as saving it to a file `contoso.rego`:
Expand Down