Configuring Cloudsmith plugin

Introduction

The Cloudsmith plugin allows you to display statistics about a Cloudsmith repository to the homepage.

This page explains how to configure it in Roadie.

At a Glance

Prerequisites

1. You must be an admin in Roadie. Learn how to designate certain users as admins here.
2. You must have the correct permissions assigned in Cloudsmith to be able to create a read only API key

Step 1: Create a Cloudsmith API key

Roadie requires an API key to be able to connect to Cloudsmith.

You can learn how to generate an API key for your user by visiting https://help.cloudsmith.io/docs/api-key

Step 2: Configure Roadie with your Cloudsmith API key

Visit the secrets page in Roadie at /administration/secrets and enter the API key you generated for Cloudsmith in the secret called CLOUDSMITH_API_KEY

Step 3: Add the UI elements

The Cloudsmith plugin provides a four cards that can be displayed on the homepage.

These cards can be added to component dashboards.

CloudsmithStatsCard

The CloudsmithStatsCard shows statistics about a repository in Cloudsmith.

CloudsmithQuotaCard

The CloudsmithQuotaCard shows the quotas remaining across a Cloudsmith organisation.

CloudsmithRepositoryAuditLogCard

The CloudsmithRepositoryAuditLogCard shows the autit log for a repository.

CloudsmithRepositorySecurityCard

The CloudsmithRepositorySecurityCard displays the security informantion about a repository.