Quay actions for Backstage

This module provides Backstage template actions for Quay.

The following actions are currently supported in this module:

• Create a Quay repository

Installation

Run the following command to install the action package in your Backstage project

yarn workspace backend add @janus-idp/backstage-scaffolder-backend-module-quay

Installing the action on the legacy backend

1. Register the Quay actions by modifying the packages/backend/src/plugins/scaffolder.ts file from your project with the following changes:

   import { CatalogClient } from '@backstage/catalog-client';
   import { ScmIntegrations } from '@backstage/integration';
   import {
     createBuiltinActions,
     createRouter,
   } from '@backstage/plugin-scaffolder-backend';
   
   import { Router } from 'express';
   
   import { createQuayRepositoryAction } from '@janus-idp/backstage-scaffolder-backend-module-quay';
   
   import type { PluginEnvironment } from '../types';
   
   export default async function createPlugin(
     env: PluginEnvironment,
   ): Promise<Router> {
     const catalogClient = new CatalogClient({
       discoveryApi: env.discovery,
     });
   
     const integrations = ScmIntegrations.fromConfig(env.config);
   
     const builtInActions = createBuiltinActions({
       integrations,
       catalogClient,
       config: env.config,
       reader: env.reader,
     });
   
     const actions = [...builtInActions, createQuayRepositoryAction()];
   
     return await createRouter({
       actions,
       logger: env.logger,
       config: env.config,
       database: env.database,
       reader: env.reader,
       catalogClient,
       identity: env.identity,
     });
   }

2. Optional: If you are doing the previous step for the first time, you also have to install the @backstage/integration package

   yarn workspace backend add @backstage/integration

Installing the action on the new backend

Add the following to your packages/backend/src/index.ts file:

const backend = createBackend();

// Add the following line
backend.add(
  import('@janus-idp/backstage-scaffolder-backend-module-quay/alpha'),
);

backend.start();

Configuration

Add the Quay actions to your templates, see the example file in this repository for complete usage examples

action: quay:create-repository
id: create-quay-repo
name: Create quay repo
input:
  baseUrl: https://quay.io
  token: UW1dLVdCTj8uZWNuIW97K1k0XiBkSmppVU9MYzFT
  name: foo
  visibility: public
  description: This is a foo repository
  namespace: bar
  repoKind: image

Usage

Action: quay:create-repository

Input

| Parameter Name | Type | Required | Description | Example | | -------------- | :----: | :------: | --------------------------------------------------------------------------------- | ---------------------------------------- | | name | string | Yes | Quay repository name | foo | | visibility | string | Yes | Visibility setting for the created repository, either public or private | public | | description | string | Yes | Description for the created repository | This if foo repository | | token | string | Yes | Authentication token, see docs | UW1dLVdCTj8uZWNuIW97K1k0XiBkSmppVU9MYzFT | | baseUrl | string | No | Base url of a quay instance, defaults to https://quay.io | https://foo.quay.io | | namespace | string | No | Namespace to create repository in, defaults to the namespace the token belongs to | bar | | repoKind | string | No | Created repository kind, either image or application, if empty defaults to image | image |

Output

| Name | Type | Description | | ------------- | :----: | ------------------------------------------ | | repositoryUrl | string | Quay repository URL created by this action |