Skip to content

Commit

Permalink
chore(migration): refactor repo and image (#2181)
Browse files Browse the repository at this point in the history
* chore(CI): refactor repo URL and image repo - E2E

* Dynamic plugins package.json

* Docs

* Others
  • Loading branch information
zdrapela authored Jan 14, 2025
1 parent ee3bde5 commit e628a2b
Show file tree
Hide file tree
Showing 106 changed files with 140 additions and 140 deletions.
2 changes: 1 addition & 1 deletion .ibm/pipelines/env_variables.sh
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ HELM_IMAGE_NAME=backstage
HELM_REPO_NAME=rhdh-chart
HELM_REPO_URL="https://redhat-developer.github.io/rhdh-chart"
K8S_CLUSTER_TOKEN_ENCODED=$(printf "%s" $K8S_CLUSTER_TOKEN | base64 | tr -d '\n')
QUAY_REPO="${QUAY_REPO:-janus-idp/backstage-showcase}"
QUAY_REPO="${QUAY_REPO:-rhdh-community/rhdh}"

RELEASE_NAME=rhdh
RELEASE_NAME_RBAC=rhdh-rbac
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ upstream:
image:
pullPolicy: Always
registry: quay.io
repository: janus-idp/backstage-showcase
repository: rhdh-community/rhdh
tag: next
appConfig:
app:
Expand Down
10 changes: 5 additions & 5 deletions .ibm/pipelines/value_files/values_showcase-rbac.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ global:
# -- Array of YAML files listing dynamic plugins to include with those listed in the `plugins` field.
# Relative paths are resolved from the working directory of the initContainer that will install the plugins (`/opt/app-root/src`).
includes:
# -- List of dynamic plugins included inside the `janus-idp/backstage-showcase` container image, some of which are disabled by default.
# This file ONLY works with the `janus-idp/backstage-showcase` container image.
# -- List of dynamic plugins included inside the `rhdh-community/rhdh` container image, some of which are disabled by default.
# This file ONLY works with the `rhdh-community/rhdh` container image.
- 'dynamic-plugins.default.yaml'

# -- List of dynamic plugins, possibly overriding the plugins listed in `includes` files.
Expand Down Expand Up @@ -117,9 +117,9 @@ upstream:
backstage:
image:
pullPolicy: Always
# using test image from https://quay.io/repository/janus-idp/backstage-showcase
# using test image from https://quay.io/repository/rhdh-community/rhdh
registry: quay.io
repository: janus-idp/backstage-showcase
repository: rhdh-community/rhdh
tag: next
appConfig:
app:
Expand Down Expand Up @@ -205,7 +205,7 @@ upstream:
- name: install-dynamic-plugins
# -- Image used by the initContainer to install dynamic plugins into the `dynamic-plugins-root` volume mount.
# It could be replaced by a custom image based on this one.
# @default -- `quay.io/janus-idp/backstage-showcase:latest`
# @default -- `quay.io/rhdh-community/rhdh:latest`
image: '{{ include "backstage.image" . }}'
command:
- sh
Expand Down
6 changes: 3 additions & 3 deletions .ibm/pipelines/value_files/values_showcase.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ global:
# -- Array of YAML files listing dynamic plugins to include with those listed in the `plugins` field.
# Relative paths are resolved from the working directory of the initContainer that will install the plugins (`/opt/app-root/src`).
includes:
# -- List of dynamic plugins included inside the `janus-idp/backstage-showcase` container image, some of which are disabled by default.
# This file ONLY works with the `janus-idp/backstage-showcase` container image.
# -- List of dynamic plugins included inside the `rhdh-community/rhdh` container image, some of which are disabled by default.
# This file ONLY works with the `rhdh-community/rhdh` container image.
- 'dynamic-plugins.default.yaml'

# -- List of dynamic plugins, possibly overriding the plugins listed in `includes` files.
Expand Down Expand Up @@ -127,7 +127,7 @@ upstream:
image:
pullPolicy: Always
registry: quay.io
repository: janus-idp/backstage-showcase
repository: rhdh-community/rhdh
tag: next
extraEnvVars:
- name: BACKEND_SECRET
Expand Down
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ yarn tsc # Run type ge

### Run the Showcase App

We currently have quite a bit of moving parts for the showcase application. As such, we have documentation dedicated to the requirements for running the showcase app under [getting-started.md](https://github.com/janus-idp/backstage-showcase/blob/main/docs/index.md).
We currently have quite a bit of moving parts for the showcase application. As such, we have documentation dedicated to the requirements for running the showcase app under [getting-started.md](https://github.com/redhat-developer/rhdh/blob/main/docs/index.md).

### Useful Scripts

Expand All @@ -40,11 +40,11 @@ We welcome code and non-code contributions to our project. Non-code contribution

### Finding Issues to Work On

Want to submit some changes to the code? The best place to start is to look through our issues for [bugs](https://github.com/janus-idp/backstage-showcase/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fbug), [good first issues](https://github.com/janus-idp/backstage-showcase/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), and [help wanted](https://github.com/janus-idp/backstage-showcase/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). These are a great starting point for new contributors.
Want to submit some changes to the code? The best place to start is to look through our issues for [bugs](https://github.com/redhat-developer/rhdh/issues?q=is%3Aopen+is%3Aissue+label%3Akind%2Fbug), [good first issues](https://github.com/redhat-developer/rhdh/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22), and [help wanted](https://github.com/redhat-developer/rhdh/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22). These are a great starting point for new contributors.

### Bug Reporting

If you found a bug in our showcase app, please submit an [issue](https://github.com/janus-idp/backstage-showcase/issues/new?assignees=&labels=kind%2Fbug%2Cstatus%2Ftriage&template=bug.md) describing the problem that you ran into. Important information to include:
If you found a bug in our showcase app, please submit an [issue](https://github.com/redhat-developer/rhdh/issues/new?assignees=&labels=kind%2Fbug%2Cstatus%2Ftriage&template=bug.md) describing the problem that you ran into. Important information to include:

- Steps to reproduce the bug
- The `app-config.yaml` that is being used (**remember to remove all secrets before sharing**)
Expand All @@ -62,15 +62,15 @@ yarn versions:bump # Updates Backstage dependencies

### Enhancement Requests

If you want an enhancement of a feature or workflow, you can submit an [issue](https://github.com/janus-idp/backstage-showcase/issues/new?assignees=&labels=kind%2Fenhancement%2Cstatus%2Ftriage&template=enhancement.md) describing the enhancement. Include:
If you want an enhancement of a feature or workflow, you can submit an [issue](https://github.com/redhat-developer/rhdh/issues/new?assignees=&labels=kind%2Fenhancement%2Cstatus%2Ftriage&template=enhancement.md) describing the enhancement. Include:

- What you are wanting to see improved
- The current behavior
- The new behavior you wish to see

### Feature Requests

If you want to see a new feature within the showcase app, file an [issue](https://github.com/janus-idp/backstage-showcase/issues/new?assignees=&labels=kind%2Ffeature%2Cstatus%2Ftriage&template=feature.md) detailing the new feature. Include:
If you want to see a new feature within the showcase app, file an [issue](https://github.com/redhat-developer/rhdh/issues/new?assignees=&labels=kind%2Ffeature%2Cstatus%2Ftriage&template=feature.md) detailing the new feature. Include:

- What you are trying to achieve with the new feature
- What you will need
Expand Down Expand Up @@ -179,4 +179,4 @@ You can reach out to us in our [community Slack channel](https://join.slack.com/

## License

By contributing, you agree that your contributions will be licensed under the [Apache-2.0 License](https://github.com/janus-idp/backstage-showcase/blob/main/LICENSE).
By contributing, you agree that your contributions will be licensed under the [Apache-2.0 License](https://github.com/redhat-developer/rhdh/blob/main/LICENSE).
2 changes: 1 addition & 1 deletion app-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ catalog:
- allow: [Component, System, Group, Resource, Location, Template, API]
locations:
- type: url
target: https://github.com/janus-idp/backstage-showcase/blob/main/catalog-entities/all.yaml
target: https://github.com/redhat-developer/rhdh/blob/main/catalog-entities/all.yaml

- type: url
target: https://github.com/redhat-developer/red-hat-developer-hub-software-templates/blob/main/templates.yaml
Expand Down
2 changes: 1 addition & 1 deletion catalog-entities/apis/nexus-repo-manager-3.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ spec:
owner: janus-authors
lifecycle: production
definition:
$openapi: https://github.com/janus-idp/backstage-showcase/blob/main/catalog-entities/apis/nexus-swagger.json
$openapi: https://github.com/redhat-developer/rhdh/blob/main/catalog-entities/apis/nexus-swagger.json
6 changes: 3 additions & 3 deletions catalog-entities/components/showcase.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ metadata:
annotations:
argocd/app-name: 'janus-idp'
backstage.io/kubernetes-id: 'janus-idp'
github.com/project-slug: janus-idp/backstage-showcase
quay.io/repository-slug: janus-idp/backstage-showcase
backstage.io/techdocs-ref: url:https://github.com/janus-idp/backstage-showcase
github.com/project-slug: redhat-developer/rhdh
quay.io/repository-slug: rhdh-community/rhdh
backstage.io/techdocs-ref: url:https://github.com/redhat-developer/rhdh
backstage.io/kubernetes-namespace: janus-idp-prod
sonarqube.org/project-key: janus-idp_backstage-showcase
spec:
Expand Down
2 changes: 1 addition & 1 deletion catalog-entities/resources/github.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ metadata:
title: GitHub Showcase repository
description: We store our deployment manifests and code for the janus showcase in this GitHub repository.
links:
- url: https://github.com/janus-idp/backstage-showcase
- url: https://github.com/redhat-developer/rhdh
title: GitHub Repository
icon: web
spec:
Expand Down
2 changes: 1 addition & 1 deletion docker/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ If you want an image that runs on Mac M1 (arm64/aarch64) or another architecture
Check out this repo, choose the branch or tag you want to use, then build an image:

```
podman build -f docker/Dockerfile . -t janus-idp/backstage-showcase:local
podman build -f docker/Dockerfile . -t redhat-developer/rhdh:local
```

## Downstream builds
Expand Down
6 changes: 3 additions & 3 deletions docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ dynamicPlugins:

See [Menu items](dynamic-plugins/frontend-plugin-wiring.md#menu-items) from dynamic-plugins documentation for more details.

See [DefaultMainMenuItems](https://github.com/janus-idp/backstage-showcase/blob/main/packages/app/src/consts.ts#L1) for a list of main menu items, including their default priorities.
See [DefaultMainMenuItems](https://github.com/redhat-developer/rhdh/blob/main/packages/app/src/consts.ts#L1) for a list of main menu items, including their default priorities.

## Changing the favicon and tab title

Expand Down Expand Up @@ -143,12 +143,12 @@ Example configurations:
```
app:
support:
url: https://github.com/janus-idp/backstage-showcase/issues # Used as contact support link on common ErrorPage
url: https://github.com/redhat-developer/rhdh/issues # Used as contact support link on common ErrorPage
items: # Used by common SupportButton component
- title: Issues
icon: github
links:
- url: https://github.com/janus-idp/backstage-showcase/issues
- url: https://github.com/redhat-developer/rhdh/issues
title: GitHub Issues
- title: Join the community
icon: chat
Expand Down
4 changes: 2 additions & 2 deletions docs/dynamic-plugins/frontend-plugin-wiring.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ Up to 3 levels of nested menu items are supported.
- For `path: /docs`, the `menu_item_name` should be `docs`.
- For `path: /metrics/users`, the `menu_item_name` should be `metrics.users`.

- `icon` - Optional. Defines the icon for the menu item, which refers to a Backstage system icon. See [Backstage system icons](https://backstage.io/docs/getting-started/app-custom-theme/#icons) for the default list, or extend the icon set using dynamic plugins. RHDH also provides additional icons in its internal library. See [CommonIcons.tsx](https://github.com/janus-idp/backstage-showcase/blob/main/packages/app/src/components/DynamicRoot/CommonIcons.tsx) for reference. If the icon is already defined in the `dynamicRoutes` configuration under `menuItem.icon`, it can be omitted in the `menuItems` configuration.
- `icon` - Optional. Defines the icon for the menu item, which refers to a Backstage system icon. See [Backstage system icons](https://backstage.io/docs/getting-started/app-custom-theme/#icons) for the default list, or extend the icon set using dynamic plugins. RHDH also provides additional icons in its internal library. See [CommonIcons.tsx](https://github.com/redhat-developer/rhdh/blob/main/packages/app/src/components/DynamicRoot/CommonIcons.tsx) for reference. If the icon is already defined in the `dynamicRoutes` configuration under `menuItem.icon`, it can be omitted in the `menuItems` configuration.
- `title` - Optional. Specifies the display title of the menu item. This can also be omitted if it has already been defined in the `dynamicRoutes` configuration under `menuItem.text`.
- `priority` - Optional. Defines the order in which menu items appear. The default priority is `0`, which places the item at the bottom of the list. A higher priority value will position the item higher in the sidebar.
- `parent` - Optional. Defines the parent menu item to nest the current item under. If specified, the parent menu item must be defined somewhere else in the `menuItems` configuration of any enabled plugin.
Expand Down Expand Up @@ -459,7 +459,7 @@ dynamicPlugins:
- `importName` is an optional import name that reference a `AnyApiFactory<{}>` implementation. Defaults to `default` export.
- `module` is an optional argument which allows you to specify which set of assets you want to access within the plugin. If not provided, the default module named `PluginRoot` is used. This is the same as the key in `scalprum.exposedModules` key in plugin's `package.json`.

There are a set of [API factories](https://github.com/janus-idp/backstage-showcase/blob/main/packages/app/src/apis.ts) already initialized by the Developer Hub application shell. These API factories can be overridden by an API factory provided by a dynamic plugin by specifying the same API ref ID, for example a dynamic plugin could export the following `AnyApiFactory<{}>` to cater for some specific use case:
There are a set of [API factories](https://github.com/redhat-developer/rhdh/blob/main/packages/app/src/apis.ts) already initialized by the Developer Hub application shell. These API factories can be overridden by an API factory provided by a dynamic plugin by specifying the same API ref ID, for example a dynamic plugin could export the following `AnyApiFactory<{}>` to cater for some specific use case:

```typescript
export const customScmAuthApiFactory = createApiFactory({
Expand Down
2 changes: 1 addition & 1 deletion docs/dynamic-plugins/installing-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Plugins are defined in the `plugins` array in the `dynamic-plugin-config.yaml` f

## Dynamic plugins included in the Showcase container image

The showcase container image is preloaded with a variety of dynamic plugins, the majority of which are initially disabled due to mandatory configuration requirements. The comprehensive list of these plugins is outlined in the [`dynamic-plugins.default.yaml`](https://github.com/janus-idp/backstage-showcase/blob/main/dynamic-plugins.default.yaml) file.
The showcase container image is preloaded with a variety of dynamic plugins, the majority of which are initially disabled due to mandatory configuration requirements. The comprehensive list of these plugins is outlined in the [`dynamic-plugins.default.yaml`](https://github.com/redhat-developer/rhdh/blob/main/dynamic-plugins.default.yaml) file.

Upon the application startup, for each plugin disabled by default, the `install-dynamic-plugins` init container within the `backstage` Pod's log will exhibit a line similar to the following:

Expand Down
Loading

0 comments on commit e628a2b

Please sign in to comment.