@harnessio/backstage-plugin-ci-cd

harness-ci-cd

Welcome to the Harness CI/CD plugin for Backstage!

Getting started

Steps

1. Configure proxy for harness in app-config.yaml. Add your Harness Personal Access Token or Service Account Token for x-api-key (see the Harness docs )

# In app-config.yaml

proxy:
  '/harness':
    target: 'https://app.harness.io/'
    headers:
      'x-api-key': '<YOUR PAT/SAT>'

Note: If you have separate providers for CI and CD apart from Harness, you need to add a new tab for Harness pipelines instead of replacing your existing CI or CD tab.

1. Inside your EntityPage.tsx, update the cicdContent to render <EntityHarnessCiCdContent /> whenever service is using Harness CI/CD. Example below

// In packages/app/src/components/catalog/EntityPage.tsx

import {
  isHarnessCiCdAvailable,
  EntityHarnessCiCdContent,
} from '@harnessio/backstage-plugin-ci-cd';

const cicdContent = (
  // ...
  <EntitySwitch.Case if={isHarnessCiCdAvailable}>
    <EntityHarnessCiCdContent />
  </EntitySwitch.Case>
  // ...
);

1. Configure baseUrl for harness in app-config.yaml

# In app-config.yaml

harness:
  baseUrl: https://app.harness.io/

1. Add required harness specific annotations to your respective catalog-info.yaml files, (example: https://github.com/harness/backstage-plugins/blob/main/examples/catalog-harness-cicd.yaml)