Create and manage vaults

As an administrator or space owner, you can create and configure local, remote, and virtual vaults.

PulseUno supports Maven, npm, Docker, Python PIP, and NuGet package managers. For guidelines on how to populate vaults, see Deploy packages.

Maven 3.8.1 and later: Because Maven 3.8.1 and later doesn't support non-HTTPS repositories, we recommend that you configure your Vault server for HTTPS. For details, see information about configuring web tools for HTTPS in the Dimensions CM Administration Guide. To continue using HTTP, see Configure HTTP access to Maven vaults.

Create local vaults

A local vault is stored in a local file system or repository.

To create a local vault:

  1. From the spaces list at the top right, select a space.

  2. In the sidebar, select Vaults.

  3. On the Vaults page, click Create vault and select Local.

  4. On the new vault page, provide the following details:

    Field Description
    Vault title Enter a name for the local vault.
    Description (Optional) Enter a description for the vault.
    Package type

    Select a vault package type: Maven, npm, Docker, PyPI, or NuGet.

    After you create a vault, you cannot change the vault's package type.
    Access

    Select the access permission:

    • Authenticated (default). Provides full access to the vault to any logged in user.

    • Anonymous. Provides read-only access to the vault. No login authentication is required.

      A vault with the Anonymous permission is a public vault.
    Read only

    Select this option to lock the vault, preventing packages being pushed to the vault.

    By default, the vault is open for package deliveries.
    Dependency vulnerability check

    (Optional) To regularly check for security issues in vault packages, select Enable automatic checking of packages for dependency vulnerabilities.

    Using this option, you instruct PulseUno to continuously update packages in the vault with any new security vulnerabilities that may be discovered. The results are reported in the Dependency Vulnerabilities tab of the related package version.

    For details on how PulseUno identifies security issues, see Detect dependency vulnerabilities.
    Storage type

    Select a storage type:

    • Filesystem. The vault is stored on your local machine.

    • Dimensions CM. The vault is stored in a local Dimensions CM repository. Select a connection to an existing CM repository or create a new connection. For details, see Connect to Dimensions CM repository.

    We recommend using a single stream/branch per vault. After you create a vault, you cannot change the vault's storage type.

  5. Click Save.

Back to top

Create remote vaults

A remote vault caches copies of content from a remote system.

To create a remote vault:

  1. From the spaces list at the top right, select a space.
  2. In the sidebar, select Vaults.

  3. On the Vaults page, click Create vault and select Remote.

  4. On the new vault page, provide the following details:

    Field Description
    Vault title Enter a name for the remote vault.
    Description (Optional) Enter a description for the remote vault.
    Package type

    Select a vault package type: Maven, npm, Docker, PyPI, or NuGet.

    After you create a vault, you cannot change the vault's package type.
    Access

    Select the access permission:

    • Authenticated (default). Provides full access to the vault to any logged in user.

    • Anonymous. Provides read-only access to the vault. No login authentication is required.

      A vault with the Anonymous permission is a public vault.

    Read only

    By default, the vault is set to read-only, preventing packages being pushed to the vault.

    Clear this option to allow package deliveries to the vault.
    Dependency vulnerability check

    (Optional) By default, PulseUno is set to continuously check vault packages for new security issues that may be discovered.

    To stop the regular check for dependency vulnerabilities, clear the option Enable automatic checking of packages for dependency vulnerabilities.

    For details on how PulseUno identifies security issues, see Detect dependency vulnerabilities.
    Remote Vault Connection
    Remote URL

    Enter the URL of the remote repository to be cached, for example:

    https://repo1.maven.org/maven2/

    Username (Optional) Enter a username to authenticate to the remote vault.
    Password

    (Optional) Enter the password for the remote vault username.

    Note: PulseUno securely stores the remote vault credentials on your Vault server.
    Storage type

    Select a storage type:

    • Filesystem. The vault is stored in a local system.

    • Dimensions CM. The vault is stored in a local CM repository. Select a connection to an existing CM repository or create a new connection. For details, see Connect to Dimensions CM repository.

    We recommend using a single stream/branch per vault. After you create a vault, you cannot change the vault's storage type.
  5. Click Save.

Back to top

Create virtual vaults

A virtual vault is a collection of local and remote vaults.

The order of the vaults in a virtual vault is important. Vaults are searched in descending order, starting from the first one, to locate matching packages during package download. After you create a virtual vault, change the vaults order as required.

To create a virtual vault:

  1. From the spaces list at the top right, select a space.
  2. In the sidebar, select Vaults.
  3. On the Vaults page, click Create vault and select Virtual.

  4. On the new vault page, provide the following details:

    Field Description
    Vault title Enter a name for the virtual vault.
    Description (Optional) Enter a description for the virtual vault.
    Package type

    Select a vault package type: Maven, npm, Docker, PyPI, or NuGet.
    Access

    Select the access permission:

    • Authenticated (default). Provides full access to the vault to any logged in user.

    • Anonymous. Provides read-only access to the vault. No login authentication is required.

      A vault with the Anonymous permission is a public vault.

    Dependency vulnerability check

    (Optional) To regularly check for security issues in vault packages, select Enable automatic checking of packages for dependency vulnerabilities.

    Using this option, you instruct PulseUno to continuously update packages in the vault with any new security vulnerabilities that may be discovered.

    For details on how PulseUno identifies security issues, see Detect dependency vulnerabilities.
  5. Click Save.

To add vaults to a virtual vault:

  1. Open the virtual vault you have created.

  2. In the Vaults tab, click Add vaults .

  3. In the Add Vaults dialog box, search for the vaults you want to add. Enter a search string and press Enter.

  4. Select one or more vaults from the search results and click Add.

  5. (Optional) After you have added vaults, change their order by dragging them to different locations.

Back to top

Specify the vault to publish packages

Because virtual vaults contain multiple vaults, you need to specify the default vault for capturing artifacts. When you deliver packages to a virtual vault, the packages are deployed to the vault which you set as published.

Guidelines:

  • Only one vault in a virtual vault can be designated as published.
  • You can change the published vault anytime.
  • You cannot deploy to a virtual vault if you have not set the published vault.

To specify the vault to publish packages to:

  1. From the spaces list at the top right, select a space.

  2. In the sidebar, select Vaults.

  3. On the Vaults page, open a virtual vault.

  4. On the virtual vault's page, select the vault to be published.

  5. Click Publish.

To stop deployments to the published vault, select the vault and click Unpublish.

For details on how to deliver and publish packages, see Deploy packages and Publish packages.

Back to top

Edit vault settings

As an administrator or space owner, you can change settings and configurations for existing vaults.

To edit a vault's settings:

  1. From the spaces list at the top right, select a space.

  2. In the sidebar, select Vaults.

  3. On the Vaults page, open a local or remote vault. You can also open vaults inside virtual vaults.

  4. In the sidebar, select Settings > General.

  5. Update the settings of your vault, as needed. You cannot change the package type and storage type.

    Field Description
    Vault title Change the vault's name.
    Description Update the vault's description.
    Access

    Change the access permission:

    • Authenticated. Provides full access to the vault to any logged in user.

    • Anonymous. Provides public read-only access to the vault. No login authentication is required.

    Read only

    Local and remote vaults: Select this option to lock the vault, preventing packages being pushed to the vault.

    Clear this option to allow package deliveries to the vault.
    Dependency vulnerability check

    Local and remote vaults: Enable or disable regular checks for security issues in vault packages.

    Using this option, you instruct PulseUno to continuously update packages in the vault with any new security vulnerabilities that may be discovered. The results are reported in the Dependency Vulnerabilities tab of the related package version.

    For details on how PulseUno identifies security issues, see Detect dependency vulnerabilities.
    Remote Vault Connection (remote vaults only)
    Remote URL

    If your vault URL has changed, for example, because the vault has moved to another host, you can update the URL to point to the new location.

    Caution: Do not change the URL to a different vault.
    Username Enter a username to authenticate to the remote vault.
    Password Click Set password and enter the password for the remote vault username.

  6. Click Save.

Back to top

Delete vaults

As an administrator or space owner, you can delete vaults. By default, deleted vaults are scheduled to be permanently removed after 7 days. During those 7 days, you can cancel the deletion anytime.

To delete a vault:

  1. From the spaces list at the top right, select a space.

  2. In the sidebar, select Vaults.

  3. On the Vaults page, open the vault you want to delete.

  4. In the sidebar, select Settings > Advanced.

  5. Click Delete this vault and confirm the deletion.

    The vault is now scheduled to be deleted in 7 days.

  6. To delete the vault instantly, click Complete Deletion Now.

  7. In the warning dialog box, enter the name of the relevant space and vault.

  8. Click Complete Deletion Now. The vault is permanently removed.

To stop the vault deletion:

  1. From the spaces list at the top right, select a space.

  2. In the sidebar, select Vaults.

  3. On the Vaults page, open the vault scheduled to be deleted.

  4. In the sidebar, select Settings > Advanced.

  5. Click Stop deletion and confirm your action.

Back to top

See also: