README.md

Backstage Workshop

Setup Digital-ai Deploy [optional]

1. Run the following command to run deploy in docker container. More details on docker images of xl-deploy

docker run -e "ADMIN_PASSWORD=admin" -e "ACCEPT_EULA=Y" -p 4516:4516 -d --name xld xebialabsunsupported/xl-deploy:24.1

2. Run the following command to create Application, Infrastructure, Environment and deploy the application in the created Environment using Digital-ai Deploy.

Run the command from the root directory.

docker pull xebialabsunsupported/xl-client:24.1

docker run  -v $(pwd):$(pwd) -w $(pwd) xebialabsunsupported/xl-client:24.1 apply -f deploy/deploy-application.yaml --xl-deploy-url http://<deployhost>:4516/ -name xlcli

Note: Before Running the above command please update "http://deployhost:4516/" with actual deploy url.

Setup Digital-ai Release [optional]

1. Run the following command to run deploy in docker container. More details on docker images of xl-release

docker run -e "ADMIN_PASSWORD=admin" -e "ACCEPT_EULA=Y" -p 5516:5516 -d --name xlr-23.3 xebialabsunsupported/xl-release:24.1

Configure npmrc file with the following content, available in home directory.

1. Windows
   a.%USERPROFILE%.npmrc (eg: C:\Users\username.npmrc)
2. Linux a.~/.npmrc (eg: /home/username/.npmrc)
3. Mac a.~/.npmrc (eg: /Users/username/.npmrc)
4. Content of the npmrc file. a. Add the following content to the npmrc file.

# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
# yarn lockfile v1
registry=https://registry.npmjs.org/
strict-ssl=false
@digital-ai:registry=https://registry.npmjs.org

Setup backstage using legacy backend system.

1. Run the following command from root directory

cd backstage-with-legacy-backend

2. Configure the deploy and release instance from previous step or else configure the existing instance by adding the following to your app-config.yaml files.

daiDeploy:
  host: http://<deployhost>:4516
  username: '<username>'
  password: '<password>'
  
daiRelease:
   instances:
      - name: 'Production'
        host: http://<releasehost>:5516/
        token: <ACCESS-TOKEN> # Generated token from the release instance.
      - name: 'QE'
        host: http://<releasehost>:5516/
        token: <ACCESS-TOKEN> # Generated token from the release instance.
      - name: 'Staging'
        host: http://<releasehost>:5516/
        token: <ACCESS-TOKEN> # Generated token from the release instance.

3. Run the following command to start the backstage app with deploy plugin installed.

yarn install

yarn dev

4. View the Digital-ai Deploy - Active Deployment in Backstage app.

5. View the Digital-ai Release - Active Release in Backstage app.

Setup backstage using New backend system.

1. Run the following command from root directory

cd backstage-with-new-backend

2. Configure the deploy and release instance from previous step or else configure the existing instance by adding the following to your app-config.yaml files.

daiDeploy:
  host: http://<deployhost>:4516
  username: 'admin'
  password: 'admin'
daiRelease:
  host: http://<releasehost>:5516
  token: rpa_862c5cd8b6e76f551d4f4b2e862e1e8a34be3972 # Generated token from the release instance.

3. Run the following command to start the backstage app with deploy plugin installed.

yarn install

yarn dev

4. View the Digital-ai Deploy - Active Deployment in Backstage app.

5. View the Digital-ai Release - Active Release in Backstage app.

Documentation Links

Digital.ai Deploy:

• Deploy Integration with Backstage
• Adding Deploy to Your Backstage IDP

Digital.ai Release:

• Overview
• Adding Release Plugin to Your Backstage IDP