Scaffold a requirements.yml file for collection dependencies #2652
Conversation
Users will now install the operator_sdk.util and community.kubernetes collections at operator build time rather than them being baked into the base image. This allows us to put version pins to ensure compatibility of user Ansible content even when updating the base image. This should make it safer and easier for users to update to newer versions of the base image, as well as make it more transparent where the Ansible content they execute is coming from. It also allows us to push new features and bugfixes out to users via the collections without having to continually re-release the base image with new content. This will be a breaking change for existing users of the collection however. In order to continue working, users will have to add a requirements.yml to their projects and add an install step to their build/Dockerfile.
| @@ -95,6 +97,9 @@ RUN TINIARCH=$(case $(arch) in x86_64) echo -n amd64 ;; ppc64le) echo -n ppc64el | |||
| && curl -L -o /tini https://github.com/krallin/tini/releases/latest/download/tini-$TINIARCH \ | |||
| && chmod +x /tini | |||
|
|
|||
| [[- if .Requirements ]] | |||
| COPY requirements.yml ${HOME}/requirements.yml | |||
| RUN ansible-galaxy collection install -r ${HOME}/requirements.yml[[ end ]] | |||
There was a problem hiding this comment.
We need to add it in the migration guide. See: https://github.com/operator-framework/operator-sdk/blob/master/doc/migration/version-upgrade-guide.md#unreleased
| @@ -73,13 +76,12 @@ RUN yum clean all && rm -rf /var/cache/yum/* \ | |||
| && pip3 install --no-cache-dir --ignore-installed ipaddress \ | |||
| ansible-runner==1.3.4 \ | |||
| ansible-runner-http==1.0.0 \ | |||
| openshift==0.9.2 \ | |||
| openshift~=0.10.0 \ | |||
There was a problem hiding this comment.
Add entry in the changelog over the upgrade of openshift version.
| @@ -95,6 +97,9 @@ RUN TINIARCH=$(case $(arch) in x86_64) echo -n amd64 ;; ppc64le) echo -n ppc64el | |||
| && curl -L -o /tini https://github.com/krallin/tini/releases/latest/download/tini-$TINIARCH \ | |||
| && chmod +x /tini | |||
|
|
|||
| [[- if .Requirements ]] | |||
There was a problem hiding this comment.
Add entry in the changelog over requirements. Is not it a breaking change?
There was a problem hiding this comment.
This part is not a breaking change, but existing users will indeed need to add a requirements file to their existing projects to pull in the operator_sdk.util collection and community.kubernetes collection. Added to changelog and migration guide
fabianvf
force-pushed
the
requirements-yml
branch
from
7d5a206 to
5b95ee8
Compare
test/ansible/build/Dockerfile
Outdated
| @@ -1,5 +1,8 @@ | |||
| FROM quay.io/operator-framework/ansible-operator:dev | |||
| FROM quay.io/operator-framework/ansible-operator | |||
There was a problem hiding this comment.
Should not here it still being dev tag?
To use the image built in the CI?
There was a problem hiding this comment.
ah whoops, good catch that was a change for local testing
fabianvf
force-pushed
the
requirements-yml
branch
from
5b95ee8 to
23f518b
Compare
Users will now install the operator_sdk.util and community.kubernetes
collections at operator build time rather than them being baked into
the base image. This allows us to put version pins to ensure
compatibility of user Ansible content even when updating the base image.
This should make it safer and easier for users to update to newer
versions of the base image, as well as make it more transparent where
the Ansible content they execute is coming from. It also allows us to
push new features and bugfixes out to users via the collections without
having to continually re-release the base image with new content.
This will be a breaking change for existing users of the collection
however. In order to continue working, users will have to add a
requirements.yml to their projects and add an install step to their
build/Dockerfile.
Description of the change:
Motivation for the change: