particle-os/debian-image-builder-frontend
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
debian-image-builder-frontend/README.md
Tom Gundersen bbf5bf8642 README: split frontend and backend instructions 
Spinning up the frontend is a lot simpler than the backend, so have dedicated
instructions to just do that.
2021-05-08 22:27:51 +02:00

2.8 KiB
Raw Blame History

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 cloud.redhat.com.

  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/apps/image-builder/landing.

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. In addition to the above:

  1. Clone the image-builder (backend) repository: https://github.com/osbuild/image-builder

  2. Setting up the proxy

    As before, choose a runner (podman or docker), and point the SPANDX_CONFIG variable to profile/local-frontend-and-api-with-identity.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-and-api-with-identity.js
    sudo -E insights-proxy/scripts/run.sh

  3. Setting up osbuild-composer(-api)

    The easiest way to do this is to call schutzbots/provision-composer.sh from the osbuild/image-builder project. This will install composer, generate the needed certs, and put the configuration in place.

  4. Starting up image-builder

    Point the URL to wherever composer is hosted, the client certificates and CA should be reused or copied over from the composer host, they're located in /etc/osbuild-composer.

    In the image-builder checkout directory

        make build
    OSBUILD_URL="https://$composer-url:$composer-port/api/composer/v1" \
    OSBUILD_CERT_PATH=/path/to/client-crt.pem \
    OSBUILD_KEY_PATH=/path/to/client-key.pem \
    OSBUILD_CA_PATH=/path/to/ca-crt.pem \
    ./image-builder

  5. 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/apps/image-builder/landing, the api (image-builder) on https://prod.foo.redhat.com:1337/api/image-builder/v1/openapi.json