https://github.com/keptn-sandbox/backstage-plugin-keptn

Backstage plugin for Keptn
https://github.com/keptn-sandbox/backstage-plugin-keptn

backstage backstage-plugin keptn

Last synced: 22 days ago
JSON representation

Backstage plugin for Keptn

• Host: GitHub
• URL: https://github.com/keptn-sandbox/backstage-plugin-keptn
• Owner: keptn-sandbox
• License: apache-2.0
• Created: 2022-01-20T16:52:14.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-01-24T14:47:41.000Z (over 3 years ago)
• Last Synced: 2024-11-05T09:45:00.577Z (6 months ago)
• Topics: backstage, backstage-plugin, keptn
• Language: TypeScript
• Homepage:
• Size: 415 KB
• Stars: 8
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

• awesome-starred - keptn-sandbox/backstage-plugin-keptn - Backstage plugin for Keptn (others)

README

        
# Backstage Plugin Keptn

Welcome to the keptn plugin!

## Installation steps

```

yarn add @krateo/backstage-plugin-keptn

```

Add proxy config to the app-config.yaml file

```

proxy:

  "/keptn-api":

    target: http:///api/v1/

    secure: false

    headers:

      x-token: KEPTN_API_AUTH_TOKEN

  "/keptn":

    target: http://bridge/api/

    secure: false

    headers:

      Authorization: "Basic KEPTN_AUTH_TOKEN"

```

```

// packages/app/src/plugins.ts

export { keptnPlugin } from '@krateo/backstage-plugin-keptn';

```

Add keptn widget to your overview page

```

import {

  EntityKeptnProjectCard,

  EntityKeptnServiceCard,

  isKeptnProjectAvailable,

  isKeptnServiceAvailable,

  EntityKeptnContent,

} from '@krateo/backstage-plugin-keptn';

const overviewContent = (

  

  ...

    

      

        

          

        

      

    

  ...

  

);

const serviceEntityPage = (

  

  ...

    

      

    

  ...

  

);

const systemPage = (

  

    

    ...

      

        

          

            

              

            

          

        

      

    ...

    

  

);

```

Add annotation to the yaml config file of a component

```

metadata:

  annotations:

    keptn.sh/project: 

    keptn.sh/service: 

```

Get and provide env variables in following format

```

KEPTN_API_AUTH_TOKEN: is the token that is generated by the kpetn-api

KEPTN_AUTH_TOKEN: token for keptn ui. username:password in base64 (commonly is keptn:)

```

## How it looks

### System

![image description](https://github.com/krateoplatformops/backstage-plugin-keptn/blob/main/docs/system.png?raw=true)

### Component Overview

![image description](https://github.com/krateoplatformops/backstage-plugin-keptn/blob/main/docs/overview.png?raw=true)

### Keptn Tab

![image description](https://github.com/krateoplatformops/backstage-plugin-keptn/blob/main/docs/tab.png?raw=true)