Moved from root note to title

Signed-off-by: Andre Wanlin <awanlin@spotify.com>
This commit is contained in:
Andre Wanlin
2024-07-13 10:45:17 -05:00
parent 5442edda31
commit 1145181834
34 changed files with 51 additions and 91 deletions
+1 -2
View File
@@ -25,8 +25,7 @@ This will only work with the new backend system. There is no support for this in
Add the `@backstage/plugin-auth-backend-module-guest-provider` to your backend installation.
```sh
# From your Backstage root directory
```sh title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-auth-backend-module-guest-provider
```
@@ -173,8 +173,7 @@ To create the Backend module, run `yarn new`, select `backend-module`. Then fill
This will create a new package at `plugins/kubernetes-backend-module-pinniped`. We are going to need also the `@backstage/plugin-kubernetes-node` and `@backstage/plugin-kubernetes-common` dependencies, the `@backstage/plugin-kubernetes-node` houses the [kubernetesAuthStrategyExtensionPoint](https://github.com/backstage/backstage/blob/ebe7afad9d19f279469168ca0d4feceb92c1ad36/plugins/kubernetes-node/src/extensions.ts#L77) and a [Pinniped Helper](https://github.com/backstage/backstage/blob/ebe7afad9d19f279469168ca0d4feceb92c1ad36/plugins/kubernetes-node/src/auth/PinnipedHelper.ts#L53) class.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd plugins/kubernetes-backend-module-pinniped add @backstage/plugin-kubernetes-node
yarn --cwd plugins/kubernetes-backend-module-pinniped add @backstage/plugin-kubernetes-common
```
+3 -6
View File
@@ -15,8 +15,7 @@ If you haven't setup Backstage already, read the
The first step is to add the Kubernetes frontend plugin to your Backstage
application.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/app add @backstage/plugin-kubernetes
```
@@ -53,8 +52,7 @@ work.
Navigate to `packages/backend` of your Backstage app, and install the
`@backstage/plugin-kubernetes-backend` package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-kubernetes-backend
```
@@ -109,8 +107,7 @@ To get the Kubernetes plugin install using the New Backend System you will need
Run this command to add the package:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-kubernetes-backend
```
+2 -4
View File
@@ -16,8 +16,7 @@ If you haven't setup Backstage already, start
## Adding Search to the Frontend
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/app add @backstage/plugin-search @backstage/plugin-search-react
```
@@ -133,8 +132,7 @@ For more information about using `Root.tsx`, please see
Add the following plugins into your backend app:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-search-backend @backstage/plugin-search-backend-node
```
@@ -184,8 +184,7 @@ Catalog errors are published to the [events plugin](https://github.com/backstage
The first step is to add the events backend plugin to your Backstage application. Navigate to your Backstage application directory and add the plugin package.
```ts
# From your Backstage root directory
```ts title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-events-backend
```
@@ -201,8 +200,7 @@ If you want to log catalog errors you can install the `@backstage/plugin-catalog
Install the catalog logs module.
```ts
# From your Backstage root directory
```ts title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-logs
```
@@ -24,8 +24,7 @@ There are also several modules available for various SCM tools:
Here's how to add an action module, first you need to run this command:
```sh
# From your Backstage root directory
```sh title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-scaffolder-backend-module-github
```
+3 -6
View File
@@ -21,8 +21,7 @@ The first step is to add the TechDocs plugin to your Backstage application.
Navigate to your new Backstage application directory. And then to your
`packages/app` directory, and install the `@backstage/plugin-techdocs` package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/app add @backstage/plugin-techdocs
```
@@ -106,8 +105,7 @@ That's it! Now, we need the TechDocs Backend plugin for the frontend to work.
Navigate to `packages/backend` of your Backstage app, and install the
`@backstage/plugin-techdocs-backend` package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-techdocs-backend
```
@@ -199,8 +197,7 @@ To install TechDocs when using the New Backend system you will need to do the fo
Navigate to `packages/backend` of your Backstage app, and install the `@backstage/plugin-techdocs-backend` package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-techdocs-backend
```
+1 -2
View File
@@ -73,8 +73,7 @@ to install and configure the client.
Go to the root directory of your freshly installed Backstage
App. Run the following to install the PostgreSQL client into your backend:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add pg
```
@@ -21,8 +21,7 @@ to an entity in the software catalog.
1. Add the plugin's npm package to the repo:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/app add @circleci/backstage-plugin
```
+1 -2
View File
@@ -28,8 +28,7 @@ Now, let's get started by installing the home plugin and creating a simple homep
#### 1. Install the plugin
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/app add @backstage/plugin-home
```
+1 -2
View File
@@ -66,8 +66,7 @@ catalog:
As this provider is not one of the default providers, you will first need to install
the AWS catalog plugin:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-aws
```
+1 -2
View File
@@ -66,8 +66,7 @@ catalog:
As this provider is not one of the default providers, you will first need to install
the AWS catalog plugin:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-aws
```
+1 -2
View File
@@ -102,8 +102,7 @@ It may take some time before the branch is indexed and searchable.
As this provider is not one of the default providers, you will first need to install
the Azure catalog plugin:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-azure
```
+1 -2
View File
@@ -102,8 +102,7 @@ It may take some time before the branch is indexed and searchable.
As this provider is not one of the default providers, you will first need to install
the Azure catalog plugin:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-azure
```
+1 -2
View File
@@ -18,8 +18,7 @@ Microsoft Graph API.
The package is not installed by default, therefore you have to add `@backstage/plugin-catalog-backend-module-msgraph` to your backend package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-msgraph
```
+1 -2
View File
@@ -18,8 +18,7 @@ Microsoft Graph API.
The package is not installed by default, therefore you have to add `@backstage/plugin-catalog-backend-module-msgraph` to your backend package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-msgraph
```
@@ -19,8 +19,7 @@ backend. The provider is not installed by default, therefore you have to add a
dependency to `@backstage/plugin-catalog-backend-module-bitbucket-cloud` to your backend
package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-bitbucket-cloud
```
@@ -19,8 +19,7 @@ backend. The provider is not installed by default, therefore you have to add a
dependency to `@backstage/plugin-catalog-backend-module-bitbucket-server` to your backend
package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-bitbucket-server
```
+1 -2
View File
@@ -16,8 +16,7 @@ stored in the root of the matching projects.
As this provider is not one of the default providers, you will first need to install
the Gerrit provider plugin:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-gerrit
```
+2 -4
View File
@@ -25,8 +25,7 @@ backend. They are not installed by default, therefore you have to add a
dependency on `@backstage/plugin-catalog-backend-module-github` to your backend
package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github
```
@@ -273,8 +272,7 @@ backend. They are not installed by default, therefore you have to add a
dependency on `@backstage/plugin-catalog-backend-module-github` to your backend
package, plus `@backstage/integration` for the basic credentials management:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/integration @backstage/plugin-catalog-backend-module-github
```
+1 -2
View File
@@ -24,8 +24,7 @@ You will have to add the GitHub Entity provider to your backend as it is not ins
dependency on `@backstage/plugin-catalog-backend-module-github` to your backend
package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github
```
+2 -4
View File
@@ -29,8 +29,7 @@ the Processor method (not recommended), it is described separately below.
The provider is not installed by default, therefore you have to add a dependency
to `@backstage/plugin-catalog-backend-module-github` to your backend package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github
```
@@ -334,8 +333,7 @@ frequency with which they are refreshed, separately from other processors.
The `GithubOrgReaderProcessor` is not registered by default, so you have to
install and register it in the catalog plugin:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github
```
+1 -2
View File
@@ -38,8 +38,7 @@ You will have to add the GitHub Org provider to your backend as it is not instal
dependency on `@backstage/plugin-catalog-backend-module-github-org` to your backend
package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-github-org
```
+1 -2
View File
@@ -20,8 +20,7 @@ This provider can also be configured to ingest GitLab data based on [GitLab Webh
As this provider is not one of the default providers, you will first need to install
the gitlab catalog plugin:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-gitlab
```
+1 -2
View File
@@ -25,8 +25,7 @@ This provider can also be configured to ingest GitLab data based on [GitLab Syst
As this provider is not one of the default providers, you will first need to install the Gitlab provider plugin:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-gitlab @backstage/plugin-catalog-backend-module-gitlab-org
```
+1 -2
View File
@@ -24,8 +24,7 @@ the Processor method (not recommended), it is described separately below.
The provider is not installed by default, therefore you have to add a dependency
to `@backstage/plugin-catalog-backend-module-ldap` to your backend package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-ldap
```
+1 -2
View File
@@ -21,8 +21,7 @@ Backstage in general supports OpenLDAP compatible vendors, as well as Active Dir
The provider is not installed by default, therefore you have to add a dependency
to `@backstage/plugin-catalog-backend-module-ldap` to your backend package.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-catalog-backend-module-ldap
```
+1 -2
View File
@@ -50,8 +50,7 @@ The permissions framework uses a new `permission-backend` plugin to accept autho
1. Add `@backstage/plugin-permission-backend` as a dependency of your Backstage backend:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @backstage/plugin-permission-backend
```
+1 -2
View File
@@ -39,8 +39,7 @@ The source code is available here:
2. Add these packages as dependencies for your Backstage app:
```sh
# From your Backstage root directory
```sh title="From your Backstage root directory"
yarn --cwd packages/backend add @internal/plugin-todo-list-backend @internal/plugin-todo-list-common
yarn --cwd packages/app add @internal/plugin-todo-list
```
+1 -2
View File
@@ -71,8 +71,7 @@ Backstage application / backend exposes it.
To actually attach and run the plugin router, you will make some modifications
to your backend.
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add @internal/plugin-carmen-backend@^0.1.0 # Change this to match the plugin's package.json
```
+2 -4
View File
@@ -248,8 +248,7 @@
1. First we need to add the @backstage/plugin-azure-devops package to your frontend app:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn add --cwd packages/app @backstage/plugin-azure-devops
```
@@ -313,8 +312,7 @@
1. First we need to add the @backstage/plugin-azure-devops package to your frontend app:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn add --cwd packages/app @backstage/plugin-azure-devops
```
+2 -4
View File
@@ -10,8 +10,7 @@
1. First we need to add the @backstage/plugin-azure-devops package to your frontend app:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn add --cwd packages/app @backstage/plugin-azure-devops
```
@@ -69,8 +68,7 @@
1. First we need to add the @backstage/plugin-azure-devops package to your frontend app:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn add --cwd packages/app @backstage/plugin-azure-devops
```
@@ -36,12 +36,15 @@ Please ensure the appropriate database drivers are installed in your `backend`
package. If you intend to use both PostgreSQL and SQLite, you can install
both of them.
```bash
# From your Backstage root directory
# install pg if you need PostgreSQL
yarn --cwd packages/backend add pg
Install pg if you need PostgreSQL:
# install SQLite 3 if you intend to set it as the client
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add pg
```
Install SQLite 3 if you intend to set it as the client:
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add better-sqlite3
```
+1 -2
View File
@@ -19,8 +19,7 @@ switch between database backends.
First, add PostgreSQL to your `backend` package:
```bash
# From your Backstage root directory
```bash title="From your Backstage root directory"
yarn --cwd packages/backend add pg
```