Create and manage vaults

This topic describes how to create, configure, or delete local, remote, and virtual vaults.

PulseUno supports Maven, npm, Docker, and Python PIP package managers.

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 vaults.

Create local vaults

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

To create a local vault:

  1. In PulseUno, navigate to Spaces and select a space.

  2. In the sidebar, select Vaults.

  3. On the Vaults page, click Add and select Local. The New Local Vault page opens.

  4. Enter the following details for the local vault:

    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, or PyPI.

    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.

    Vulnerability check

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

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

    For details on how PulseUno identifies vulnerabilities, see Vulnerability detection.

    Storage type

    Select a storage type:

    • Filesystem. The vault will be stored on your local machine.
    • Dimensions CM. The vault will be 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 a 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. In PulseUno, navigate to Spaces and select a space.
  2. In the sidebar, select Vaults.
  3. On the Vaults page, click Add and select Remote. The New Remote Vault page opens.
  4. Enter the following details for the remote vault:

    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, or PyPI.

    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.

    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 vulnerability check, clear the Enable automatic checking of packages for vulnerabilities option.

    For details on how PulseUno identifies vulnerabilities, see Vulnerability detection.

    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 for accessing the remote vault.
    Password

    (Optional) Enter a password for accessing the remote vault.

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

    Storage type

    Select a storage type:

    • Filesystem. The vault will be stored in a local system.
    • Dimensions CM. The vault will be stored in a local CM repository. Select a connection to an existing CM repository or create a new connection. For details, see Connect to a 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. In PulseUno, navigate to Spaces and select a space.
  2. In the sidebar, select Vaults.
  3. On the Vaults page, click Add and select Virtual. The New Virtual Vault page opens.
  4. Enter the following details for the virtual vault:

    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, or PyPI
    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.

    Vulnerability check

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

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

    For details on how PulseUno identifies vulnerabilities, see Vulnerability detection.

  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 .

  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

Virtual vaults contain multiple vaults. When you deliver packages to a virtual vault, the packages are deployed to the vault which you set as published.

When working with virtual vaults, take into account:

  • Only one vault in a virtual vault can be 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. In PulseUno, navigate to Spaces and 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 Populate vaults with packages and Publish packages to a vault.

Back to top

Edit vault settings

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

To edit a vault's settings:

  1. In PulseUno, navigate to Spaces and select a space.

  2. In the sidebar, select Vaults.

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

  4. In the sidebar, select Settings.

  5. Edit the vault's general settings. You can change any setting except 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 (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.

    Clear this option to allow package deliveries to the vault.

    Vulnerability check

    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 vulnerabilities that may be discovered. The results are reported in the Vulnerabilities tab of the related package version.

    For details on how PulseUno identifies vulnerabilities, see Vulnerability detection.

  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. In PulseUno, navigate to Spaces and 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. In PulseUno, navigate to Spaces and 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: