Cargo
Create a Cargo registry, generate an identity token, then publish and install Rust crates with the Cargo CLI through your Harness Artifacts registry.
Use a Cargo registry to host private Rust crates for the Cargo CLI.
What you will learn from this topic
By the end of this quickstart guide, you will be able to:
Create a registry in Harness Artifacts.
Publish a package to the registry.
Install the package from the registry, and confirm that it works.
Before you begin
Install the Cargo CLI (
cargo), which ships with the Rust toolchain, on your local machine.Make sure you have access to a Harness account with permission to create registries and connectors.
Create a Cargo Registry
To create a Cargo registry, perform the following steps:
In Artifact Registry, select Registries.
Select + Create Registry.
Specify the Registry name.
Optionally, add a Description.
Choose visibility between Public and Private. The default is Private.
Select Cargo as the Registry type.
Select Save.
Select Create to finalize.
Configure an upstream proxy (optional)
An upstream proxy allows your registry to fetch Cargo crates from crates.io when they are not available locally. The default upstream is crates.io.
Create upstream proxy
To create an upstream proxy, perform the following steps:
In Artifact Registry, select Registries.
Select the drop-down next to + Create Registry and select Upstream Proxy.
Specify the Registry name.
Optionally, add a Description.
Choose visibility between Public and Private. The default is Private.
Select Cargo as the Registry type.
Select the Source: Crates.io or Custom.
If you select Custom, specify the Remote registry URL.
Select the Authentication method.
Username and password: Specify the username and password. Use an existing secret, or create a new secret by specifying the Name and entering the Secret text.
Anonymous: No credentials required. This works for the public crates.io registry.
Optionally, configure the Metadata configuration:
Metadata cache TTL (seconds): How long Harness caches crate metadata from the upstream before it checks for updates.
Negative cache TTL (seconds): How long Harness caches a failed lookup before it retries the upstream.
To decide the right cache duration for your registry, go to Metadata configuration.
Select Create to finalize.
Configure the upstream proxy in your registry
To configure the upstream proxy in your registry, perform the following steps:
In Artifact Registry, select an existing Cargo registry.
Navigate to the Configuration tab.
Select Edit in the Upstream proxy section.
Select + Add upstream proxy.
Select the required proxy from the list.
Select Apply.
Select Update to finalize.
Cargo client setup
In your Cargo Artifact, select the registry, then select Set Up Client.
Generate an identity token
An identity token serves as the password for authenticating with the registry.
In your Cargo registry, select Set Up Client.
Select Generate Token.
Select an Expiration for the token:
30 Days
90 Days
180 Days
Custom
Copy the token. You use it in the following steps in place of
<IDENTITY_TOKEN>.
Configure the client
In the code samples, replace the values in angle brackets with your own values.
1. Configure the client
Add the following to ~/.cargo/config.toml:
Add the following to ~/.cargo/credentials.toml:
2. Publish the crate
Publish your crate to the registry:
3. Use the crate
Add the crate to your project:
Setup verification
Confirm that your registry serves the crate you published. To verify your setup, perform the following steps:
In a new directory with no cached registry index,
Cargo.lockfile, or vendored dependencies, use the Cargo CLI to add the crate you published.Confirm that Cargo downloaded the crate from your Harness registry address, which is shown in Set Up Client.
In Harness, open your registry and confirm that the crate and version appear in the package list.
If a step fails, go to Troubleshooting to resolve common authentication and resolution issues before you retry.
Pipeline automation (optional)
Publishing from a pipeline gives you a repeatable release process. Run the publish step when you create a version tag, so each release maps to one version in the registry.
The following Run step bumps the crate version from the pipeline's tag before publishing. Store the identity token as a Harness secret, and do not write it into the pipeline YAML.
Troubleshooting
Next steps
To add a pipeline that publishes a new version for every release tag, go to Harness CI.
To control who can publish and consume packages in your registry, go to RBAC and permissions.
To set retention and lifecycle rules for old versions, go to Lifecycle Management overview.
Last updated
Was this helpful?