Skip to content

Extend custom ci for app doc #898

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.

Sign up for GitHub

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

Merged
kprosise merged 2 commits into from
Mar 16, 2026
Merged

Extend custom ci for app doc #898

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8617a4e
ug: custom-ci: mention `fioctl` usage to verify target creation
mike-sul Mar 10, 2026
12674a0
ug: custom-ci: add doc on publishing app to 3rd party registries
mike-sul Mar 10, 2026
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
33 changes: 33 additions & 0 deletions source/user-guide/custom-ci/custom-ci-for-apps.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,36 @@
-------------------------

You can view your Factory Targets in the UI to check whether the new Targets were created, and if their content is correct.
This can also be verified by running ``fioctl targets list`` and ``fioctl targets show <target-version>``.

Using Third-Party Container Registries
--------------------------------------

It is possible to push the built container images and the Compose App to a third-party container registry instead of the default `FoundriesFactory Registry`_.

Check warning on line 113 in source/user-guide/custom-ci/custom-ci-for-apps.rst

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Fio-docs.FoundriesFactory-trademark] 'FoundriesFactory' should be marked as an unregistered trademark first time it occurs in body of text and used as an adjective.

Raw Output:
{"message": "[Fio-docs.FoundriesFactory-trademark] 'FoundriesFactory' should be marked as an unregistered trademark first time it occurs in body of text and used as an adjective.", "location": {"path": "source/user-guide/custom-ci/custom-ci-for-apps.rst", "range": {"start": {"line": 113, "column": 131}}}, "severity": "WARNING"}

To do so, use `the sample GitHub actions workflow`_ as a starting point and:

1. Modify the workflow so it can authenticate and obtain **write access** to your container registry.
2. Set the appropriate value for the ``IMAGE_BASE_URL`` environment variable and optionally ``IMAGE_NAMESPACE``.

``IMAGE_BASE_URL`` should point to the base URL of the container registry where images will be pushed.

Example: Using Amazon ECR
~~~~~~~~~~~~~~~~~~~~~~~~~

This is an `example GitHub Actions workflow`_ that builds container images and pushes them,
along with the Compose App, to **Amazon Elastic Container Registry (ECR)**.

The workflow extends the base workflow by:

- adding steps that authenticate the workflow to AWS
- granting the workflow permission to push images to ECR
- setting ``IMAGE_BASE_URL`` to the ECR registry URL

Authentication to AWS is performed using **OpenID Connect (OIDC)**.

With OIDC, a GitHub workflow requests a short-lived identity token from GitHub and exchanges it with AWS for **temporary credentials**.
These credentials allow the workflow to interact with AWS services such as ECR without storing long-lived AWS access keys in GitHub.

.. _FoundriesFactory Registry:
https://hub.foundries.io
Expand All @@ -127,5 +157,8 @@
.. _The sample GitHub actions workflow:
https://github.com/foundriesio/custom-ci-app/blob/custom-ci-devel/.github/workflows/fio-app-ci.yml

.. _example GitHub Actions workflow:
https://github.com/foundriesio/custom-ci-app/blob/custom-ci-devel/.github/workflows/fio-app-ci-ecr.yml

.. _composectl:
https://github.com/foundriesio/composeapp