particle-os/debian-image-builder-frontend
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Image Builder service for console.redhat.com
670 commits 9 branches 22 tags 26 MiB
Find a file
Gianluca Zuccarelli 110c0c674b
Fix docker stack (#713) 
* devel: update composer config

Update some of the config for the docker-compose
file since there have been a few changes and the
config is slightly out of date. Additionally, a
refresh_token parameter was added to the oauth_url
since this is used by composer's mock openid provider
to generate the `rh-id-org` key in the jwt token.

* distribution: update frontend entrypoint

Update the command for spinning up the frontend
to match the new script command.

* devel: remove offline token

Remove the offline token and replace
with a client secret instead.

* devel: add metrics profile

Only launch the metrics containers when
explictly requested. This helps decrease
the logging output when the metrics are
not required. The metrics can be called
with `docker-compose --profile metrics up`
2022-04-26 14:00:53 +01:00
.github ci: Extract Coverity Scan tools in /tmp 2021-11-12 12:02:43 +01:00
.travis .travis: Introduce simplified custom release script 2022-04-14 14:22:49 +02:00
config config: Let frontend-components set deployment in prod config 2022-04-14 13:05:02 +02:00
devel Fix docker stack (#713) 2022-04-26 14:00:53 +01:00
distribution Fix docker stack (#713) 2022-04-26 14:00:53 +01:00
src CreateImageWizard: Use 'gcp' image type for gcp 2022-04-25 14:00:54 +02:00
.eslintrc.yml package.json: update babel-eslint to @babel/eslint-parser 2022-03-02 09:59:19 +01:00
.gitignore Stop ignoring lock-file. 2021-10-12 15:03:04 +02:00
.stylelintrc.json package-json: remove unnused stylint-scss and bump dependencies 2022-03-24 15:48:34 +01:00
.travis.yml .travis: Enable stage-stable and prod-stable branches 2022-04-21 14:42:55 +02:00
babel.config.js babel: update the babel config 2022-04-11 13:18:30 +02:00
codecov.yml codecov.yml: reset comment to default 2021-10-28 15:02:18 +01:00
LICENSE osbuild-installer-frontend 2020-03-27 10:14:04 +01:00
package-lock.json build(deps): bump @patternfly/patternfly from 4.183.1 to 4.185.1 2022-04-12 12:48:22 +02:00
package.json package.json: Add prod-stable script 2022-04-22 16:44:48 +02:00
README.md README: update start scripts (#711) 2022-04-22 15:38:48 +01:00

README.md

image-builder-frontend

Frontend Development

To develop the frontend you can use a proxy to run image-builder-frontend locally against the chrome and backend at console.redhat.com.

Working against the production environment is preferred, as any work can be released without worrying if a feature from stage has been released yet.

Nodejs and npm version

Make sure you have npm@7 and node 15+ installed. If you need multiple versions of nodejs check out nvm.

Webpack proxy

  1. run npm ci

  2. run npm run prod-beta. This command uses a prod-beta env by default. Configure your environment by the env attribute in dev.webpack.config.js.

  3. Secondly redirect a few prod.foo.redhat.com to localhost, if this has not been done already.

echo "127.0.0.1 prod.foo.redhat.com" >> /etc/hosts
  1. open browser at https://prod.foo.redhat.com:1337/beta/insights/image-builder

Webpack proxy (staging) -- Runs with image-builder's stage deployment

  1. run npm ci

  2. run npm run stage-beta. This command uses a stage-beta env by default. Configure your environment by the env attribute in dev.webpack.config.js.

  3. Secondly redirect a few stage.foo.redhat.com to localhost, if this has not been done already.

echo "127.0.0.1 stage.foo.redhat.com" >> /etc/hosts
  1. open browser at https://stage.foo.redhat.com:1337/beta/insights/image-builder

Insights proxy (deprecated)

  1. Clone the insights proxy: https://github.com/RedHatInsights/insights-proxy

  2. Setting up the proxy

    Choose a runner (podman or docker), and point the SPANDX_CONFIG variable to profile/local-frontend.js included in image-builder-frontend.

        sudo insights-proxy/scripts/patch-etc-hosts.sh
    export RUNNER="podman"
    export SPANDX_CONFIG=$PATH_TO/image-builder-frontend/profiles/local-frontend.js
    sudo -E insights-proxy/scripts/run.sh

  3. Starting up image-builder-frontend

    In the image-builder-frontend checkout directory

        npm install
    npm start

The UI should be running on https://prod.foo.redhat.com:1337/beta/insights/image-builder/landing. Note that this requires you to have access to either production or stage (plus VPN and proxy config) of insights.

Backend Development

To develop both the frontend and the backend you can again use the proxy to run both the frontend and backend locally against the chrome at cloud.redhat.com. For instructions see devel/README.md.

Style Guidelines

This project uses eslint's recommended styling guidelines. These rules can be found here: https://eslint.org/docs/rules/

Test Guidelines

Testing is done using React Testing Library. All UI contributions must also include a new test or update an existing test in order to maintain code coverage.

Tests can be run with

    npm run test

These tests will also be run in our Travis CI when a PR is opened.