Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/redhat-actions/oc-new-app

Github Action to deploy and expose an application on Openshift
https://github.com/redhat-actions/oc-new-app

cloud deployment github-action oc openshift redhat

Last synced: about 1 month ago
JSON representation

Github Action to deploy and expose an application on Openshift

Awesome Lists containing this project

README 

        
# oc-new-app

[![CI checks](https://github.com/redhat-actions/oc-new-app/actions/workflows/ci-checks.yml/badge.svg)](https://github.com/redhat-actions/oc-new-app/actions/workflows/ci-checks.yml)

[![OpenShift Pet Clinic Workflow](https://github.com/redhat-actions/oc-new-app/actions/workflows/example.yml/badge.svg)](https://github.com/redhat-actions/oc-new-app/actions/workflows/example.yml)

[![Link checker](https://github.com/redhat-actions/oc-new-app/workflows/Link%20checker/badge.svg)](https://github.com/redhat-actions/oc-new-app/actions?query=workflow%3A%22Link+checker%22)



[![tag badge](https://img.shields.io/github/v/tag/redhat-actions/oc-new-app)](https://github.com/redhat-actions/buildah-build/tags)

[![license badge](https://img.shields.io/github/license/redhat-actions/oc-new-app)](./LICENSE)

[![size badge](https://img.shields.io/github/size/redhat-actions/oc-new-app/dist/index.js)](./dist)



**oc-new-app** is a Github Action for deploying and exposing a single-container application on OpenShift.



This action wraps [`oc new-app`](https://docs.openshift.com/container-platform/4.6/applications/application_life_cycle_management/creating-applications-using-cli.html) to provide a simple interface for deploying an application.



It creates a Deployment which runs the application Pod, and then exposes that pod to the internet through a Service and a Route.






## Prerequisites



- An OpenShift Cluster is required. To try an OpenShift cluster, visit [openshift.com/try](https://openshift.com/try) or sign up for our [Developer Sandbox](https://developers.redhat.com/developer-sandbox).

- `oc` must be installed on the GitHub Action runner you specify.

    - Presently the [Ubuntu Environments](https://github.com/actions/virtual-environments#available-environments) come with `oc` 4.7.0 installed.

    - If you want a different version of `oc`, or if you are using the Mac or Windows environments, use the [**openshift-tools-installer**](https://github.com/redhat-actions/openshift-tools-installer) to install `oc` before running this action.

- You must log in to your OpenShift cluster, preferably by using [**oc-login**](https://github.com/redhat-actions/oc-login).






## Action inputs



| Input | Description | Default |

| ----- | ----------- | ------- |

| app_name | Name to use for the generated application artifacts. | **Must be provided** |

| build_env | Environment variable key-value pairs to pass to the build container at the run time. Use the form `env_name=env_value`, and separate arguments with newlines. | None

| create_pull_secret_from | Registry credentials file to use to create a pull secret. Set this to `docker` or `podman` depending on which tool you used to log in. See [using-private-images](#using-private-images). | None

| image | The fully qualified name of the application image. It can be a container image or an image stream. For more information, refer to [the OpenShift documentation](https://docs.openshift.com/container-platform/4.7/applications/application_life_cycle_management/creating-applications-using-cli.html#applications-create-using-cli-image_creating-applications-using-cli). | **Must be provided** |

| image_pull_secret_name | In the case of private images, provide the image pull secret name if you have already created that. Otherwise, see [using-private-images](#using-private-images). | None

| namespace | OpenShift project/Kubernetes namespace to target. | Current context |

| port | A port to expose from the application container through a Service. If exactly one port is exposed in the container metadata, then this input can be omitted. For more details [see](https://docs.openshift.com/container-platform/4.7/applications/application_life_cycle_management/creating-applications-using-cli.html#applications-create-using-cli-modify_creating-applications-using-cli). | None |

| registry_hostname | The Hostname/domain of the container image registry such as quay.io, or docker.io that a private container image will be pulled from. The pull secret is used to access this registry. See [using-private-images](#using-private-images). | None

| registry_username | Registry username to use for the pull secret. | None

| registry_password | Password, encrypted password, or access token of the provided registry to use for the pull secret. | None






## Action outputs



| Output | Description |

| ------ | ----------- |

| route | URL to the application route. |

| selector | Label selector of the created resources. |






## Example



The example below shows how the **oc-new-app** action can be used to deploy and expose a

application on OpenShift.



```yaml

steps:

- name: Create and expose app

  uses: redhat-actions/oc-new-app@v1

  with:

    app_name: petclinic

    image: quay.io/redhat-github-actions/petclinic:v1

    namespace: github-actions-bot-dev

```

To build and push the container image to a registry such as [quay.io](https://quay.io), use the [**buildah-build**](https://github.com/redhat-actions/buildah-build)

and [**push-to-registry**](https://github.com/redhat-actions/push-to-registry) actions.



For a complete example see the [example workflow](.github/workflows/example.yml).






## Using private images



If your deployment requires a private image, this action will create an [image pull secret](https://docs.openshift.com/container-platform/4.7/openshift_images/managing_images/using-image-pull-secrets.html#images-allow-pods-to-reference-images-from-secure-registries_using-image-pull-secrets) which will allow

to reference image from secured registries. Use one of the methods given below to setup image pull secret:



- If you have already created the secret, use the `image_pull_secret_name` input to specify the name of the created pull secret. Make sure that secret is created in the namespace in which you want to create the deployment.



- If you have already logged in to a container image registry, use the `create_pull_secret_from` input to specify the tool you used to log in. This input tells the action where to find the credentials file to use to setup the pull secret.

Set `create_pull_secret_from` to `docker` or `podman` depending on which of those two tools you used to log in. This will create a pull secret using the credentials file.



- If you haven't already logged in to the container image registry, set inputs `registry_hostname`, `registry_username` and `registry_password` with your registry details and this action will create the pull secret.



Finally, created pull secret will be linked to the `default` service account.



Any image pull secrets created will be provided with the label `app.kubernetes.io/managed-by=oc-new-app-action`, and once this action finish it's execution created secret will be cleaned up from the cluster.



## Troubleshooting



Note that [quay.io](https://quay.io) repositories are private by default.



This means that if you push an image for the first time, you will have to authenticate before pulling it, or go to the repository's settings and change its visibility.