Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add procedure to specify docker pull secret for embedded workflow #1760

Merged
merged 1 commit into from
Nov 14, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions managing_providers/_topics/embedded_workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ In addition to the *Embedded Workflows* UI, **Embedded Workflows** can also be u

* Service Catalog Items

The provisioning, reconfigure, and retirement entry points include the option for using **Embedded Workflows** or **Embedded Automate**. You can set the point field to the workflow that you want to use for any, or all, of the three service entry points.
The provisioning, reconfigure, and retirement entry points include the option for using **Embedded Workflows** or **Embedded Automate**. You can set the point field to the workflow that you want to use for any, or all, of the three service entry points.

![Entry Points options](../../images/embedworkflow_entrypointsembedded.png)

Expand Down Expand Up @@ -169,21 +169,23 @@ Workflows must be authored in Amazon State Languages (ASL) format. As part of au

When you have the code for your task resource written, you need to bundle it into a docker image. You can bundle the code by creating a standard [Dockerfile](https://docs.docker.com/engine/reference/builder/) and building the image (https://docs.docker.com/engine/reference/commandline/build/). Then, you can push the image to a [registry](https://docs.docker.com/engine/reference/commandline/push/), which makes the image available to be used by {{ site.data.product.title_short }}. When you have pushed your images to an image registry, you can add the registry to {{ site.data.product.title_short }}.

a) On appliances, `podman` is used to execute the container
* On appliances, `podman` is used to execute the container

On appliances, `podman` is used to execute the container so use [podman login](https://docs.podman.io/en/stable/markdown/podman-login.1.html) as the `manageiq` user.

```
```text
# su manageiq
$ podman login docker.io
Username:
Password:
Login Succeeded!
```

You are recommended to use a docker.io [access token](https://docs.docker.com/security/for-developers/access-tokens/) so that the token does not expire.
You are recommended to use a docker.io [access token](https://docs.docker.com/security/for-developers/access-tokens/) so that the token does not expire.

* Provide an image pull secret to a podified Kubernetes container, and then add it to a service account

b) Provide an image pull secret to a podified Kubernetes container, and then add it to a service account
In order to pull an image from a private registry you have to provide an `ImagePullSecret` to your containers, see [Pull an Image from a Private Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). {{ site.data.product.title_short }} uses a service account called `manageiq-default` to run containers for your workflows. You can add an `ImagePullSecret` to this service account by following [Add Image Pull Secrets to a service account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account/).
In order to pull an image from a private registry you have to provide an `ImagePullSecret` to your containers, see [Pull an Image from a Private Registry](https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/). {{ site.data.product.title_short }} uses a service account called {{ site.data.product.workflow_service_account }} to run containers for your workflows. You can add an `ImagePullSecret` to this service account by following [Add Image Pull Secrets to a service account](https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/#add-imagepullsecrets-to-a-service-account/).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aileenjackson Since this adds {{ site.data.product.workflow_service_account }} I expected to see a change to the _data/product.yml file here as well. Can you please include that file with that change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure. For IBM docs (infra-mgmt) it's @ https://github.ibm.com/Aileen-Jackson/infra-mgmt-docs/pull/2/commits/74ecbd71f682e670ed0dd3ca00c1e9ff1d8942b7 and for ManageIQ docs it's 01f919f. I did the PR but couldn't seem to add you after the fact. Thanks Aileen

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh I see it in #1761


#### Example: Provisioning Workflow

Expand Down