Compare commits

..

2 commits

Author SHA1 Message Date
4ed3dc8d2a backstage update tutorial, part 2 2025-04-24 13:40:17 +02:00
97a09ce1b3 backstage update tutorial 2025-04-23 15:36:53 +02:00
9 changed files with 103 additions and 486 deletions

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 327 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 92 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 59 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 78 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 32 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 237 KiB

View file

@ -1,35 +0,0 @@
# MVP1-12-OTC Milestone
Date: 24.04.25
https://lucid.app/lucidspark/7134abcb-0c5e-41e5-93da-7118e285a668/edit?invitationId=inv_fbf0d105-7023-4740-806e-fcbb522ea61a&page=0_0#
## Overall
### Architecture
![alt text](<EDP Forgejo Arch - Page 1.svg>)
### Work packages
![alt text](<EDP Forgejo Arch - Page 1 (2).svg>)
## EDP Foundry
### Sub-Components 'Internal Services' and 'Central Observaability'
![alt text](<EDP Forgejo Arch - Page 1 (3).svg>)
## EDP (deployed per tenant)
### Sub-Components 'Kubernetes' and 'Cloud Services'
![alt text](<EDP Forgejo Arch - Page 1 (4).svg>)
## Operator (Provisioning Pipeline)
### Sub-Components 'Forgejo-Actions' and 'ArgoCD'
![alt text](<EDP Forgejo Arch - Page 1 (5).svg>)
![alt text](<EDP Forgejo Arch - Page 1 (6).svg>)

View file

@ -0,0 +1,103 @@
---
title: Backstage Update Tutorial
---
The first Backstage update was performed as described in the ticket https://jira.telekom-mms.com/browse/IPCEICIS-2299 from version 1.28 to version 1.36.1.
This document provides a detailed guide on the process to update Backstage locally on your machine from version 1.36.1 to 1.38.1.
Later updates can be performed accordingly. (The fixing of deprecated imports should not be necessary, again.)
## Table of Contents
1. [Prerequisites](#prerequisites)
2. [Setting Up Backstage](#setting-up-backstage)
3. [Updating Backstage](#updating-backstage)
4. [Fix deprecated import](#fix-deprecated-import)
5. [Running Backstage](#running-backstage)
## Prerequisites <a name="prerequisites"></a>
Before you start, make sure you have the following installed on your machine:
1. **Node.js**: Backstage requires Node.js. You can download it from the [Node.js website](https://nodejs.org/).
2. **Yarn**: Backstage uses Yarn as its package manager.
3. **Git**
4. **Docker**
## Setting Up Backstage <a name="setting-up-backstage"></a>
To download the latest version of our Backstage-EDP app, use git to clone it from the OSC repository at https://forgejo.edf-bootstrap.cx.fg1.ffm.osc.live/DevFW-CICD/backstage-edp.git.
Make sure yarn ist installed locally. If it hasn't been installed yet, run in the project path:
```bash
yarn install
```
## Updating Backstage <a name="updating-backstage"></a>
In the project path run:
```bash
yarn backstage-cli versions:bump
```
This will update all relevant components to the newest versions.
## Fix deprecated import <a name="fix-deprecated-import"></a>
In a text editor of your choice open the file <I>'/backstage-edp/packages/backend/src/plugins/proxy.ts'</I> and implement the two following changes.
### Update import
First (due to changes in the library) replace the deprecated import
```typescript
import { createRouter } from '@backstage/plugin-proxy-backend';
```
with the following import:
```typescript
import { createRouter } from '@roadiehq/backstage-plugin-argo-cd-backend';
```
### Update method call createRouter()
Secondly (due to a changed signature) replace the <B>old</B> call of method createRouter()
```typescript
return await createRouter({
logger: env.logger,
config: env.config,
discovery: env.discovery
});
```
with the following <B>new</B> method call:
```typescript
return await createRouter({
logger: env.logger,
config: env.config
});
```
## Running backstage <a name="running-backstage"></a>
After completing all updates and fixes, run backstage to verify everything was updated correctly.
In the project path run:
```bash
docker build --no-cache -t backstage-cnoe .
```
Start the backend from a console:
```bash
yarn run start-backend
```
Start the frontend from a console:
```bash
yarn run start
```
The backstage frontend should now open in your browser.

File diff suppressed because one or more lines are too long