paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 45 Packages Projects Releases Wiki Activity

docs(kubernetes): update README for new frontend system as default

Browse Source 
Add install command and package discovery blurb. Restructure so the
extension configuration is the default setup path, removing the
explicit "New Frontend System" labeling.

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
Made-with: Cursor
This commit is contained in:
Patrik Oldsberg
2026-03-04 12:07:40 +01:00
parent db7d147d17
commit adc075f557
1 changed files with 18 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/kubernetes/README.md
+18 -31
View File
@@ -8,15 +8,20 @@ It will elevate the visibility of errors where identified, and provide drill dow
It directly interfaces with the [Kubernetes Backend Plugin (`@backstage-plugin-kubernetes-backend`)](https://github.com/backstage/backstage/tree/master/plugins/kubernetes-backend).
_This plugin was created through the Backstage CLI_
## Introduction
See our announcement blog post [New Backstage feature: Kubernetes for Service Owners](https://backstage.io/blog/2021/01/12/new-backstage-feature-kubernetes-for-service-owners) to learn more about the motivation behind developing the plugin.
## Setup & Configuration
This plugin must be explicitly added to a Backstage app, along with it's peer backend plugin.
This plugin must be explicitly added to a Backstage app, along with its peer backend plugin.
```bash
# From your Backstage root directory
yarn --cwd packages/app add @backstage/plugin-kubernetes
```
Once installed, the plugin is automatically available in your app through the default package discovery. For more details and alternative installation methods, see [installing plugins](https://backstage.io/docs/frontend-system/building-apps/installing-plugins).
It requires configuration in the Backstage `app-config.yaml` to connect to a Kubernetes API control plane.
@@ -24,35 +29,9 @@ In addition, configuration of an entity's `catalog-info.yaml` helps identify whi
For more information, see the [formal documentation about the Kubernetes feature in Backstage](https://backstage.io/docs/features/kubernetes/overview).
## Getting started
### Enabling the entity content tab
Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/kubernetes](http://localhost:3000/catalog/default/component/:component-name/kubernetes).
You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory.
### Integrating with `EntityPage` (New Frontend System)
Follow this section if you are using Backstage's [new frontend system](https://backstage.io/docs/frontend-system/).
1. Import `kubernetesPlugin` in your `App.tsx` and add it to your app's `features` array:
```typescript
import kubernetesPlugin from '@backstage/plugin-kubernetes/alpha';
// ...
export const app = createApp({
features: [
// ...
kubernetesPlugin,
// ...
],
});
```
2. Next, enable your desired extensions in `app-config.yaml`.
Enable the Kubernetes entity content extension in your `app-config.yaml`:
```yaml
app:
@@ -77,3 +56,11 @@ app:
- resource
- system
```
## Getting started
Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn start` in the root directory, and then navigating to [/kubernetes](http://localhost:3000/catalog/default/component/:component-name/kubernetes).
You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory.