operator-framework · reinvantveer · Jan 20, 2021 · Jan 27, 2021 · Jan 28, 2021 · Jan 29, 2021
diff --git a/changelog/fragments/bugfix-generate-no-project-name.yaml b/changelog/fragments/bugfix-generate-no-project-name.yaml
@@ -0,0 +1,4 @@
+entries:
+  - description: >
+      Project version now determines how package name is retrieved for a project
+    kind: bugfix
diff --git a/changelog/fragments/bugfix-run-bundle-upgrade.yaml b/changelog/fragments/bugfix-run-bundle-upgrade.yaml
@@ -0,0 +1,4 @@
+entries:
+  - description: >
+      `run bundle-upgrade` handles error gracefully when a previous operator version doesn't exist
+    kind: bugfix
diff --git a/changelog/fragments/bugfix-validate-add-mode.yaml b/changelog/fragments/bugfix-validate-add-mode.yaml
@@ -0,0 +1,5 @@
+entries:
+  - description: >
+      `run bundle` and `run bundle-upgrade` now validate the value passed to the hidden flag `--mode` before
+      running a bundle.
+    kind: bugfix
diff --git a/changelog/fragments/change-finalizer-format.yaml b/changelog/fragments/change-finalizer-format.yaml
@@ -0,0 +1,12 @@
+entries:
+  - description: >
+      Changed the suggested finalizer format to `<qualified-group>/<finalizer-name>`
+    kind: change
+    migration:
+      header: Change your operator's finalizer names
+      body: >
+        The finalizer name format suggested by [Kubernetes docs](https://kubernetes.io/docs/tasks/extend-kubernetes/custom-resources/custom-resource-definitions/#finalizers)
+        is `<qualified-group>/<finalizer-name>`, while the format previously documented by Operator SDK docs was
+        `<finalizer-name>.<qualified-group>`. If your operator uses any finalizers with names matching the incorrect format,
+        change them to match the official format.
+        For example, `finalizer.cache.example.com` should be changed to `cache.example.com/finalizer`.
diff --git a/changelog/fragments/csv-gen-package-aware.yaml b/changelog/fragments/csv-gen-package-aware.yaml
@@ -0,0 +1,6 @@
+entries:
+  - description: >
+      For Go-based projects, `generate <bundle|packagemanifests>` subcommands now consider package and type names
+      when parsing Go API types files to generate a CSV's `owned.customresourcedefinitions`, such that types in
+      different packages and files will not overwrite each other.
+    kind: bugfix
diff --git a/changelog/fragments/fix-bundle-validate-failure-on-warnings.yaml b/changelog/fragments/fix-bundle-validate-failure-on-warnings.yaml
@@ -0,0 +1,6 @@
+entries:
+  - description: >
+      Bump operator-framework/api to fix "operator-sdk bundle validate" failure when bundle has warnings.
+      When a warning is detected during validation it should be logged to the CLI but the validation should still pass.
+    kind: bugfix
+    breaking: false
diff --git a/changelog/fragments/fix-bundle-validate-panic.yaml b/changelog/fragments/fix-bundle-validate-panic.yaml
@@ -0,0 +1,4 @@
+entries:
+  - description: Fix panic when "operator-sdk bundle validate" fails
+    kind: bugfix
+    breaking: false
diff --git a/changelog/fragments/fix-trim-format-dns1123-functions.yaml b/changelog/fragments/fix-trim-format-dns1123-functions.yaml
@@ -0,0 +1,8 @@
+entries:
+  - description: >
+      Fixed invalid object names generated for long package names passed
+      to `run packagemanifests` & `run bundle`.
+
+    kind: "bugfix"
+
+    breaking: false
diff --git a/changelog/fragments/helm-ansible-download-makefile.yaml b/changelog/fragments/helm-ansible-download-makefile.yaml
@@ -0,0 +1,18 @@
+entries:
+  - description: >
+      Corrected the download URL for helm-operator and ansible-operator in their respective project types.
+    kind: bugfix
+    migration:
+      header: For Helm and Ansible projects, fix the helm-operator and ansible-operator URLs in the Makefile
+      body: >
+        Helm projects: `https://github.com/operator-framework/operator-sdk/releases/download/v1.3.0/helm-operator-v1.3.0-$(ARCHOPER)-$(OSOPER)`
+        -> `https://github.com/operator-framework/operator-sdk/releases/download/v1.3.0/helm-operator_$(OS)_$(ARCH)`
+        Ansible projects: `https://github.com/operator-framework/operator-sdk/releases/download/v1.3.0/ansible-operator-v1.3.0-$(ARCHOPER)-$(OSOPER)`
+        -> `https://github.com/operator-framework/operator-sdk/releases/download/v1.3.0/ansible-operator_$(OS)_$(ARCH)`
+  - description: >
+      Fixed the order of helm-operator, ansible-operator, and kustomize binary checks in the Makefile.
+    kind: bugfix
+    migration:
+      header: For Helm and Ansible projects, fix the helm-operator, ansible-operator, and kustomize Makefile rules
+      body: >
+        See the diff in [this PR](https://github.com/operator-framework/operator-sdk/pull/4407) for details.
diff --git a/changelog/fragments/helm-uninstall-fix.yaml b/changelog/fragments/helm-uninstall-fix.yaml
@@ -0,0 +1,4 @@
+entries:
+  - description: Fixed a bug that caused the Helm operator to remove the finalizer without doing a helm uninstall.
+    kind: "bugfix"
+    breaking: false
diff --git a/changelog/fragments/helm_operator_fix_helm_keep_annotated_delete.yaml b/changelog/fragments/helm_operator_fix_helm_keep_annotated_delete.yaml
@@ -0,0 +1,5 @@
+entries:
+  - description: >
+      For Helm-based operators, do not add owner references to resources that contain the Helm annotation: 'helm.sh/resource-policy: keep'.
+    kind: bugfix
+    breaking: false
diff --git a/changelog/fragments/kuttl-v0.8.0.yaml b/changelog/fragments/kuttl-v0.8.0.yaml
@@ -0,0 +1,4 @@
+entries:
+  - description: >
+      Upgraded the `kudobuilder/kuttl` base image version in the `scorecard-test-kuttl` image to v0.8.0
+    kind: change
diff --git a/changelog/fragments/phase-2-plugin-keys.yaml b/changelog/fragments/phase-2-plugin-keys.yaml
@@ -0,0 +1,48 @@
+entries:
+  - description: >
+      (go/v2) Changed `go` PROJECT plugin object to `manifests` and `scorecard` objects (`.sdk.operatorframework.io` suffix)
+    kind: change
+    breaking: false
+    migration:
+      header: (go/v2) Change `go` PROJECT plugin object to `manifests` and `scorecard` objects
+      body: >
+        The `manifests` and `scorecard` plugins that create OLM and scorecard manifests, respectively,
+        now have plugin objects that direct `create` subcommands to create related files.
+        While the old `go` plugin configuration object is still supported, these new objects will be useful
+        in the future as configuration options are added to their respective plugins:
+
+        Old:
+        ```yaml
+        version: 3-alpha
+        ...
+        plugins:
+          go.sdk.operatorframework.io/v2-alpha: {}
+        ```
+
+        New:
+        ```yaml
+        version: 3-alpha
+        ...
+        plugins:
+          manifests.sdk.operatorframework.io/v2: {}
+          scorecard.sdk.operatorframework.io/v2: {}
+        ```
+
+  - description: >
+      (ansible/v1, helm/v1) Added plugin objects for the `manifests` and `scorecard` phase 2 plugins
+    kind: addition
+    migration:
+      header: (ansible/v1, helm/v1) Add `manifests` and `scorecard` plugin objects to your PROJECT
+      body: >
+        The `manifests` and `scorecard` plugins that create OLM and scorecard manifests, respectively,
+        now have plugin objects that direct `create` subcommands to create related files. While not necessary
+        to add, these new plugin configuration objects in the PROJECT file will be useful in the future
+        as configuration options are added to their respective plugins:
+
+        ```yaml
+        version: 3-alpha
+        ...
+        plugins:
+          manifests.sdk.operatorframework.io/v2: {}
+          scorecard.sdk.operatorframework.io/v2: {}
+        ```
diff --git a/changelog/fragments/pin-docker-base-images.yaml b/changelog/fragments/pin-docker-base-images.yaml
@@ -0,0 +1,12 @@
+# entries is a list of entries to include in
+# release notes and/or the migration guide
+entries:
+  - description: >
+      For Ansible-based and Helm-based operators, as well as for the
+      Operator SDK and the (custom) scorecard tests, the Docker base images
+      are pinned to improve the reproducibility of builds using Docker.
+
+    kind: addition
+
+    # Is this a breaking change?
+    breaking: false
diff --git a/changelog/fragments/upgrade-python-on-ansible-operator.yaml b/changelog/fragments/upgrade-python-on-ansible-operator.yaml
@@ -0,0 +1,11 @@
+entries:
+  - description: >
+      For Ansible-based operators, the Python version has been updated
+      to a newer version, from 3.6 to 3.8 to take advantage of performance
+      improvements, language additions, security updates and generally
+      better availability for local development.
+
+    kind: change
+
+    # Is this a breaking change?
+    breaking: false
diff --git a/changelog/fragments/use-pipenv-for-python-package-installation.yaml b/changelog/fragments/use-pipenv-for-python-package-installation.yaml
@@ -0,0 +1,10 @@
+entries:
+  - description: >
+      For Ansible-based operators, Python package installation in the Docker
+      image is delegated to a pipenv managed Pipfile and Pipfile.lock, pinning
+      both the main installed packages and their subdependencies. This prevents
+      installing conflicting (sub)dependencies
+
+    kind: change
+
+    breaking: false
diff --git a/images/ansible-operator/Dockerfile b/images/ansible-operator/Dockerfile
@@ -13,21 +13,20 @@ ENV HOME=/opt/ansible \
 # Install python dependencies
 # Ensure fresh metadata rather than cached metadata in the base by running
 # yum clean all && rm -rf /var/yum/cache/* first
-RUN yum clean all && rm -rf /var/cache/yum/* \
-  && yum -y update \
-  && yum install -y libffi-devel openssl-devel python38-devel gcc python38-pip python38-setuptools \
-  && pip3 install --no-cache-dir \
-    ansible-runner==1.3.4 \
-    ansible-runner-http==1.0.0 \
-    ipaddress==1.0.23 \
-    kubernetes==10.1.0 \
-    openshift==0.10.3 \
-    ansible==2.9.15 \
-    jmespath==0.10.0 \
-  && yum remove -y gcc libffi-devel openssl-devel python38-devel \
+COPY Pipfile* ./
+ENV PIP_NO_CACHE_DIR=1 \
+    PIPENV_SYSTEM=1 \
+    PIPENV_CLEAR=1
+RUN yum -y update \
+  && yum install -y python38-pip \
+  && pip3 install pipenv==2020.11.15 \
+  && pipenv install --deploy --system \
+  && pipenv check \
   && yum clean all \
   && rm -rf /var/cache/yum
 
+RUN pipenv check --system
+
 # Ensure directory permissions are properly set
 RUN echo "${USER_NAME}:x:${USER_UID}:0:${USER_NAME} user:${HOME}:/sbin/nologin" >> /etc/passwd \
   && mkdir -p ${HOME}/.ansible/tmp \

diff --git a/images/ansible-operator/Pipfile b/images/ansible-operator/Pipfile
@@ -0,0 +1,17 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+ansible-runner = "==1.4.6"
+ansible-runner-http = "==1.0.0"
+ipaddress = "==1.0.23"
+openshift = "==0.11.2"
+ansible = "==2.9.15"
+jmespath = "==0.10.0"
+
+[dev-packages]
+
+[requires]
+python_version = "3.8"