# @falupi22/plugin-komodor-backend

> Backend plugin for Komodor integration with Backstage

Latest version **0.1.1** (published 2023-11-30) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @falupi22/plugin-komodor-backend
pnpm add @falupi22/plugin-komodor-backend
yarn add @falupi22/plugin-komodor-backend
bun add @falupi22/plugin-komodor-backend
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2023-11-30 |
| First published | 2023-11-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 57.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tal Frumkin |
| Maintainers | falupi22 |

## Links

- npm: https://www.npmjs.com/package/@falupi22/plugin-komodor-backend
- Repository: https://github.com/Falupi22/backstage-komodor
- npm.io page: https://npm.io/package/@falupi22/plugin-komodor-backend

## Dependencies (10)

- [yn](https://npm.io/package/yn.md) ^4.0.0
- [express](https://npm.io/package/express.md) ^4.17.1
- [winston](https://npm.io/package/winston.md) ^3.2.1
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.7
- [@types/express](https://npm.io/package/@types/express.md) *
- [@backstage/config](https://npm.io/package/@backstage/config.md) workspace:^
- [@backstage/errors](https://npm.io/package/@backstage/errors.md) workspace:^
- [express-promise-router](https://npm.io/package/express-promise-router.md) ^4.1.0
- [@backstage/backend-common](https://npm.io/package/@backstage/backend-common.md) workspace:^
- [@backstage/backend-plugin-api](https://npm.io/package/@backstage/backend-plugin-api.md) workspace:^

## Recent versions

- 0.1.1 (latest) — 2023-11-30
- 0.1.0-18-g1396bff — 2023-11-30
- 0.1.0 — 2023-11-23
- 1.0.0-delta.1 — 2023-11-15
- 1.0.0-gamma — 2023-11-15
- 1.0.0-beta — 2023-11-14
- 1.0.0-alpha — 2023-11-14

## README

# Komodor Backend Plugin

Welcome to the Komodor backend plugin!

_This plugin was created through the Backstage CLI_

# Setup & Configuration

This plugin must be explicitly added to a Backstage app, along with it's peer front end plugin. The front end plugin should also be properly configured, as described in the README file of it. Kubernetes plugin must be added in order to use its functionality (front and back).

It requires configuration in the Backstage `app-config.yaml` to connect to a Komodor agent. For local development, you might configure `app-config.local.yaml` instead.
If you run the frontend and the backend projects from different processes, only the configuration file of the backend should be configured. Kubernetes plugin should also be
configured if k8s clusters are used by Komodor plugin.

Example:

````yaml
komodor:
  url: http://localhost:7008
  apiKey: '90890-dda2d-32acb-efad8'
````

`url`

The URL of the Komodor service.

`apiKey`

The API key used for accessing the Komodor service.

`cache` (optional)

- `shouldFetch`: Should data be fetched from the cache each client request, if
  already exists. Default is false.
- `shouldUpdate`: Should the cache be updated constantly by long polling. Default is false.

In addition, configuration of an entity's `catalog-info.yaml` helps identify which specific Komodor object(s) should be presented on a specific entity catalog page.
Specifically you might add the reference to this file to the `app.config.yaml` file,
by adding it to the `catalog.locations` field.

An example of such file can be found in `plugins/komodor-backend/examples/`.

For more information, see the [formal documentation about the Kubernetes feature in Backstage](https://backstage.io/docs/features/kubernetes/overview).

## Getting started

In order to run the full system, run `yarn dev` from the root directory.
In order to run the front end only, run `yarn start`.
In order to run the back end only, run `yarn start-backend`.

For testing without a Komodor service runnin, you might run
`node plugins/komodor-backend/src/service/komodorAgentMock/komodorServiceMock.ts`.

---
_Source: https://npm.io/package/@falupi22/plugin-komodor-backend · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._