enterprise_ai.packs.oci

Source : sdks/python/src/enterprise_ai/packs/oci.py. Retour à l'index de la référence du SDK Python.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Fonctions

repository_of

repository_of(ref: str) -> str

<host>:<port>/packs/hr:1.0.0 ou ...@sha256:... donne <host>:<port>/packs/hr.

Nom	Type	Défaut	Requis	Description
ref	str		oui	Référence OCI avec une étiquette ou un condensat.

Retour : str. Le dépôt sans étiquette ni condensat ; le port de l'hôte du registre est conservé.

push

push(ref: str, files: list[Path], plain_http: bool = False) -> dict

oras push : renvoie {reference, digest, repository}.

Nom	Type	Défaut	Requis	Description
ref	str		oui	Référence cible dans le registre, comme <registry>/packs/hr:1.0.0.
files	list[Path]		oui	Archive, SBOM et descripteur à envoyer comme couches ; ils doivent se trouver dans le même dossier.
plain_http	bool	False	non	Dialogue avec le registre en HTTP simple (--plain-http), False par défaut.

Retour : dict. Dict {reference, digest, repository}, digest étant le condensat du manifeste.

pull

pull(ref: str, out_dir: Path, plain_http: bool = False) -> list[Path]

Télécharge un artefact OCI avec oras pull dans un dossier.

Nom	Type	Défaut	Requis	Description
ref	str		oui	Référence de l'artefact, par étiquette ou par condensat @sha256:.
out_dir	Path		oui	Dossier de destination, créé s'il manque.
plain_http	bool	False	non	Dialogue avec le registre en HTTP simple (--plain-http), False par défaut.

Retour : list[Path]. Chemins triés des fichiers de out_dir après le téléchargement.

sign_artifact

sign_artifact(repository: str, digest: str, key: str | Path, password: str | None = None, insecure_registry: bool = False) -> None

Signe <repository>@<digest> avec cosign sign --key, sans envoi au journal de transparence ; un échec lève RuntimeError.

Nom	Type	Défaut	Requis	Description
repository	str		oui	Dépôt de l'artefact, sans étiquette (voir repository_of).
digest	str		oui	Condensat du manifeste sha256:<hex> renvoyé par push.
key	str | Path		oui	Chemin de la clé privée cosign (cosign.key).
password	str | None	None	non	Mot de passe de la clé ; par défaut la variable d'environnement COSIGN_PASSWORD.
insecure_registry	bool	False	non	Autorise un registre sans TLS (--allow-insecure-registry), False par défaut.

Retour : None.

verify_artifact

verify_artifact(repository: str, digest: str, public_key: str | Path, insecure_registry: bool = False) -> bool

Vérifie la signature cosign de <repository>@<digest> avec une clé publique, sans journal de transparence.

Nom	Type	Défaut	Requis	Description
repository	str		oui	Dépôt de l'artefact, sans étiquette.
digest	str		oui	Condensat du manifeste sha256:<hex> de l'artefact.
public_key	str | Path		oui	Chemin de la clé publique cosign (cosign.pub).
insecure_registry	bool	False	non	Autorise un registre sans TLS (--allow-insecure-registry), False par défaut.

Retour : bool. True si cosign verify réussit, sinon False.