Skip to content

annotations.md

Latest commit

 

History

History
43 lines (28 loc) · 1.51 KB

annotations.md

File metadata and controls

43 lines (28 loc) · 1.51 KB

Annotations

This property contains arbitrary metadata, and SHOULD follow the rules of OCI image annotations.

Pre-defined Annotation Keys

Layer Annotation Keys

  • org.cncf.model.filepath: Specifies the file path of the layer (string).

  • org.cncf.model.file.metadata+json: Specifies the metadata of the file (string), value is the JSON string of File Metadata Annotation Value.

  • org.cncf.model.file.mediatype.untested: Indicates whether the media type classification of files in the layer is untested (string). Valid values are "true" or "false". When set to "true", it signals that the model packager has not verified the media type classification and the type is inferred or assumed based on some heuristics.

Layer Annotation Values

File Metadata Annotation Value

// FileMetadata represents the metadata of file, which is the value definition of AnnotationFileMetadata.
type FileMetadata struct {
	// File name
	Name string `json:"name"`

	// File permission mode (e.g., Unix permission bits)
	Mode uint32 `json:"mode"`

	// User ID (identifier of the file owner)
	Uid uint32 `json:"uid"`

	// Group ID (identifier of the file's group)
	Gid uint32 `json:"gid"`

	// File size (in bytes)
	Size int64 `json:"size"`

	// File last modification time
	ModTime time.Time `json:"mtime"`

	// File type flag (e.g., regular file, directory, etc.)
	Typeflag byte `json:"typeflag"`
}