diff --git a/README.md b/README.md index 9fc6c81..19a4215 100644 --- a/README.md +++ b/README.md @@ -2,32 +2,55 @@ # Red Hat OpenShift Local extension +## About +Integration for [Red Hat OpenShift Local][product page] clusters. It will help you install and set up the environment. and allows you to control the lifecycle and configuration from [Podman Desktop][podman-desktop]. -This repo copied from [podman-desktop crc extension](https://github.com/containers/podman-desktop/tree/main/extensions/crc) +## Requirements +You are required to have a working [Podman Desktop][podman-desktop] installation. +Each preset of OpenShift Local has their own requirements, please check the [documentation][documentation page] for more information. -# Run and build -To prepare dev environment, use: +### Preset types + * Microshift (experimental) + provides a lightweight and optimized environment with a limited set of services. + * OpenShift + provides a single node OpenShift cluster with a fuller set of services, including a web console (requires more resources). -```shell -yarn desk:prepare -``` -This command check/clone podman-desktop, delete existing crc extension, make links, build podman-desktop without builtin OpenShift local extension. +### Pull-secret +To pull container images from the registry, a pull secret is necessary. You can get a pull secret by navigating to the dashboard and clicking the "Obtain pull-secret" or opening the [Red Hat OpenShift Local download page][download page] in your browser. -To launch podman-desktop with this OpenShift Local extension use: -```shell -yarn desk:run -``` +## Installation +From the Podman Desktop interface, go to the Settings tab and click on "Desktop Extensions". +As name fill in: `quay.io/redhat-developer/openshift-local-extension:latest` and click on the "Install extension" button. -Note: this copies the unpackaged content of the extension in `.local/share/containers/podman-desktop/plugins/openshift-local.cdix/`. +## Features -To rebuild podman-desktop and OpenShift Local extension run: + * Start/Stop/Delete OpenShift Local presets + * Change the OpenShift Local preset + * Change basic configuration -```shell - yarn desk:build -``` + +## Extension Settings + + * Memory, in MiB + * CPUs, number of cores + * Preset, Microshift or OpenShift + * Disksize, in GiB + * Pull secret file, pull secret for OpenShift + + +## Known limitation +Currently, we do not support the Podman preset of OpenShift Local. Please use preferences to change this: + +Settings > Preferences > Red Hat OpenShift Local > Preset + + +[product page]: https://developers.redhat.com/products/openshift/local +[download page]: https://cloud.redhat.com/openshift/create/local +[documentation page]: https://cloud.redhat.com/openshift/local/documentation +[podman-desktop]: https://podman-desktop.io/ \ No newline at end of file diff --git a/docs/develop.md b/docs/develop.md new file mode 100644 index 0000000..74ee78b --- /dev/null +++ b/docs/develop.md @@ -0,0 +1,26 @@ +# Development instructions + +## Run and build + +To prepare dev environment, use: + +```shell +yarn desk:prepare +``` +This command check/clone podman-desktop, delete existing crc extension, make links, build podman-desktop without builtin OpenShift local extension. + + +To launch podman-desktop with this OpenShift Local extension use: + +```shell +yarn desk:run +``` + +Note: this copies the unpackaged content of the extension in `.local/share/containers/podman-desktop/plugins/openshift-local.cdix/`. + + +To rebuild podman-desktop and OpenShift Local extension run: + +```shell + yarn desk:build +```