Docs

Container Registry

Getting started

Upload and download PyPI packages

The artifact repository supports hosting artifacts, allowing users to create artifact repositories and upload and download artifacts. This article explains how to quickly use the artifact repository to upload and download PyPI-format packages.

Prerequisites

A Volcano Engine root user has been registered. For details, refer to How to register an account.

To enable IAM users to operate the artifact repository, ensure that the relevant artifact repository policies and role authorizations have been completed. For specific operating instructions, refer to Permission Management.

Python, pip, twine, and setuptools have already been installed in the local environment (Linux/Mac).

Procedure

Step 1: Create an instance

In the left navigation bar, click Instances. Then, in the Instances area on the right page, click Create a Basic Edition Instance.

Configure the instance parameters.

Parameter	Description
Instance Name	The name of the instance, which cannot be modified.
Repository Domain Name	The domain name for accessing the repository, which is automatically generated by the system and cannot be modified.
Billing method	The billing method of the instance. Currently, only Pay-as-you-go is supported and cannot be modified.

Click Confirm to navigate to the Confirm Order interface.

After confirming the configuration details, billing type, purchase quantity, and price in the order, if there are no issues, check the box for I have read and agreed to the "Service Terms for the Basic Edition of Artifact Repository".

Click confirm and wait for the system to complete instance creation.

Step 2: Create a repository

In the left navigation bar, select Instances. In the Instances area on the right page, click to enter the artifact repository instance.

At the top of the left navigation bar, select the PyPl package format, and then in the menu bar, choose Repository Management and click on New Repository to enter the repository configuration page.

Configure the parameters of the artifact repository.

Click Confirm.

Step 3: Configure repository credentials

In the dropdown menu at the top of the left navigation bar, select the PyPI package format, and in the menu bar, select registry management.

In the repository management list, click Set permanent credentials.

Configure the credentials of the artifact repository.

Step 4: Upload package

Add the repository information of the artifact repository to the .pypirc file.

Parameter	Description
index-servers	Specifies the name of the artifact repository in the local configuration file. In this example, it is PyPI.
{repo path}	The URL address of the artifact repository. For details, please refer to Managing Repository.
{username}	The username for the artifact repository, e.g., user_demo@2100012345.
{password}	The password for accessing the artifact repository, e.g., cf83200******.

Run the following command to upload the package.

tip

In the command for uploading a package, PyPI is the name of the index-servers configured in Step 2. In practice, please modify according to your configuration.

Step 5: Download package

tip

In Linux systems, the pip.conf configuration file is typically located in the user's root directory, i.e., ~/.pip/pip.conf.

If this directory does not exist in your environment, you can create it using the mkdir.pip command in the root directory.

Add the repository information of the artifact repository to the pip.conf file.

Parameter	Description
{username}:{password}	The artifact repository's username and password, for example: user_demo@2100012345:cf83200******.
{repo path}	The URL address of the artifact repository. For details, please refer to Managing Repository.
trusted-host ={domain}	To configure a trusted domain name, simply set it as the domain name of the artifact repository. For example, artifact-beijing.volces.com.

Execute the following command to download packages.

Parameter	Description
{repo path}	The name of the package to be downloaded.

View results

Log in to the artifact repository. In the corresponding repository, you can view the list of packages that have been correctly uploaded.

Last updated: 2025.10.24 11:20:36