Backstage image - addresses issue #1 #3

awsvikram · 2023-05-17T13:33:58Z

No description provided.

nabuskey

Thank you very much for this!
I left some comments. I don't think we captured all the requirements in the issue as well as we should have done.

nabuskey · 2023-05-17T18:34:55Z

.github/workflows/docker-image.yaml

+
+jobs:
+  build:
+    runs-on: ubuntu-latest


Can we pin it to a specific version? Just in case the latest image breaks our build process for some reason. ubuntu-22.04

nabuskey · 2023-05-17T18:35:37Z

.github/workflows/docker-image.yaml

+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2


Let's use v3 since it's the latest version.
https://github.com/actions/checkout

changes made

nabuskey · 2023-05-17T18:36:17Z

.github/workflows/docker-image.yaml

+      with:
+        ref: backstage-image


This needs to be removed and use the default branch

I will default it to main

nabuskey · 2023-05-17T18:39:42Z

.github/workflows/docker-image.yaml

+  workflow_dispatch:
+    inputs:
+      branch:
+        description: "branch to build"
+        required: true
+        default: backstage-image


I don't think these are needed for building from the default branch

nabuskey · 2023-05-17T18:44:01Z

.github/workflows/docker-image.yaml

+  push:
+    branches:
+      - backstage-image


I think we want to build on sem ver tag push. Sorry this was not explicitly mentioned in the issue. Something like

on: push: tags: - 'v*.*.*'

nabuskey · 2023-05-17T18:49:29Z

.github/workflows/docker-image.yaml

+      env:
+        ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+        ECR_REPOSITORY: ${{ secrets.REPO_NAME }}
+        IMAGE_TAG: ${{ github.sha }}


Let's set the Docker tag to the git tag value. Something in this comment should work: https://github.com/orgs/community/discussions/26686#discussioncomment-3544088

can we also allow for tagging separately as part of the release? passing it via parameter or something. we can have multiple tags on the image we release.

I was thinking we use this as the GH action for sem ver tags only. Are you wanting to do it for overall cnoe release process too?

yeah I think it would be helpful if the CNOE release can be reflected on the docker image with a custom tag as well.

Let's create a separate workflow for releases then.

nimakaviani · 2023-05-19T20:00:13Z

Dockerfile

@@ -0,0 +1,48 @@
+# This dockerfile builds an image for the backend package.


why do we need a Dockerfile separate from what is here: https://github.com/cnoe-io/backstage-app/blob/main/packages/backend/Dockerfile

The backstage doc mentions it should be moved to the repo root.

really? I think the build command needs to run in the repo root but you can always build -f it and reference the Dockerfile where it is. or at least it has been what I have been doing all along and it has worked

I don't care where it goes tbh, but I'd rather follow the documentation where possible.

nimakaviani · 2023-05-19T20:01:38Z

.github/workflows/docker-image.yaml

+      env:
+        ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+        ECR_REPOSITORY: ${{ secrets.REPO_NAME }}
+        IMAGE_TAG: ${{ github.sha }}


can we also allow for tagging separately as part of the release? passing it via parameter or something. we can have multiple tags on the image we release.

nabuskey · 2023-05-25T15:21:11Z

.github/workflows/docker-image.yaml

+    branches:
+      - main
+    tags:
+      - 'v0.1.2'  


Should be v*.*.*

nabuskey · 2023-05-25T15:23:21Z

.github/workflows/docker-image.yaml

+      env:
+        ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }}
+        ECR_REPOSITORY: ${{ secrets.REPO_NAME }}
+        IMAGE_TAG: ${{ github.sha }}


Let's create a separate workflow for releases then.

nabuskey · 2023-05-25T15:24:06Z

Dockerfile

@@ -0,0 +1,48 @@
+# This dockerfile builds an image for the backend package.


I don't care where it goes tbh, but I'd rather follow the documentation where possible.

nabuskey · 2023-05-25T15:26:32Z

.github/workflows/docker-image.yaml

+  workflow_dispatch:
+    inputs:
+      branch:
+        description: "branch to build"
+        required: true
+        default: main


Since this configures manual invocation, we probably need a tag input to make sure steps below have the information necessary to build images.

nabuskey and others added 30 commits February 14, 2023 17:01

Initial commit

7e3bc0a

wip

3fa6a89

add example credential files

5ebdf36

wip

0e2fa2b

works

0919531

wait for workflow completion

f8b55bd

add custom ui plugin

26cf0bc

restrcuture plugin

98489ad

fetch from k8s proxy

f3c473c

query for workflows

617f005

wip

4fe94de

add wat flag

59c7cb8

add support for module path

93bbf69

fix linter and add auth

4db8bc3

wip

ce89b04

use oidc token

027adb7

add guards

0860bc6

wip

11cec3c

upgrade to backstage 1.21.1

383885d

added dockerfile

2b2d2f2

Added workflow for image build

e293a20

Build trigger step

0e4bc86

specifying the right branch and triggering build

b9d7f77

specify backend in workflow

61d88ee

correcting build steps

88bfef0

Enabling buildkit

86f2ad4

update env variable

cd6287e

adding github IAM role

c627a6d

IAM role for github action

dac5b9f

IAM role for github action

332162e

Venkataraman added 3 commits May 16, 2023 19:02

added permission field

295f13f

added permission field

7ffd41d

Testing build

d6ca2cd

nabuskey added the enhancement New feature or request label May 17, 2023

nabuskey linked an issue May 17, 2023 that may be closed by this pull request

create the updatable Backstage image #1

Open

nabuskey reviewed May 17, 2023

View reviewed changes

nimakaviani reviewed May 19, 2023

View reviewed changes

addressing comments

51359fe

nabuskey reviewed May 25, 2023

View reviewed changes

nabuskey closed this Feb 6, 2024

nabuskey force-pushed the main branch from 52ff604 to 4b61eae Compare February 6, 2024 18:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Backstage image - addresses issue #1 #3

Backstage image - addresses issue #1 #3

awsvikram commented May 17, 2023

nabuskey left a comment

nabuskey May 17, 2023

awsvikram May 17, 2023

nabuskey May 17, 2023

awsvikram May 17, 2023

nabuskey May 17, 2023

awsvikram May 17, 2023

nabuskey May 17, 2023

nabuskey May 17, 2023

nabuskey May 17, 2023 •

edited

Loading

nimakaviani May 19, 2023

nabuskey May 19, 2023

nimakaviani May 21, 2023

nabuskey May 25, 2023

nimakaviani May 19, 2023

nabuskey May 19, 2023

nimakaviani May 21, 2023

nabuskey May 25, 2023

nimakaviani May 19, 2023

nabuskey May 25, 2023

nabuskey May 25, 2023

nabuskey May 25, 2023

nabuskey May 25, 2023

		@@ -0,0 +1,48 @@
		# This dockerfile builds an image for the backend package.

Backstage image - addresses issue #1 #3

Backstage image - addresses issue #1 #3

Conversation

awsvikram commented May 17, 2023

nabuskey left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nabuskey May 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nabuskey May 17, 2023 •

edited

Loading