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

Outline deployment requirements #42

Merged
merged 6 commits into from
May 26, 2023

Conversation

michael-valdron
Copy link
Member

@michael-valdron michael-valdron commented Apr 12, 2023

Please specify the area for this PR

registry operator documentation

What does does this PR do / why we need it:

This PR adds an outline of requirements for deployments made by the registry operator. This ensures users who wish to use the registry operator to make deployments know what target cluster environments are supported and to avoid default namespaces.

Which issue(s) this PR fixes:

Fixes #?

fixes devfile/api#662

PR acceptance criteria:

  • Test Coverage
    • Are your changes sufficiently tested, and are any applicable test cases added or updated to cover your changes?
  • Gosec scans

Documentation

How to test changes / Special notes to the reviewer:

README.md Outdated
Deployment cluster must meet one of the following criteria:

- OpenShift Container Platform (OCP) 4.12.x
- Kubernetes 1.19.x-1.24.x
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know if the operator can support these versions. We bumped up the k8s api version to v0.26 but I don't know what the backward compatibility statement is there. We should check before making this statement.

Copy link
Member Author

Choose a reason for hiding this comment

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

@kim-tsao Looks like k8s api version v0.26.x targets Kubernetes v1.26.x if I am understanding the versions correctly here: https://github.com/kubernetes/api/releases/tag/v0.26.4

Copy link
Contributor

Choose a reason for hiding this comment

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

@michael-valdron yes it looks like that is the case. Something to keep in mind when we're upgrading these dependencies and their impact to Openshift - we need to create a matrix doc somewhere.

The k8s api version should be backwards compatible with Openshift since it's only one minor release difference. We should try to align with Openshift releases to ensure we don't move up too far ahead.

Copy link
Member Author

Choose a reason for hiding this comment

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

@michael-valdron yes it looks like that is the case. Something to keep in mind when we're upgrading these dependencies and their impact to Openshift - we need to create a matrix doc somewhere.

* [Openshift 4.12 supports Kubernetes 1.25](https://docs.openshift.com/container-platform/4.12/release_notes/ocp-4-12-release-notes.html#ocp-4-12-admin-ack-upgrading)

* [Kubernetes supported versions and skew policies](https://kubernetes.io/releases/version-skew-policy/#supported-versions)

The k8s api version should be backwards compatible with Openshift since it's only one minor release difference. We should try to align with Openshift releases to ensure we don't move up too far ahead.

@kim-tsao I requested a re-review for the matrix doc I created: https://github.com/michael-valdron/devfile-registry-operator/blob/8eb11f5f80579e672bbf770249b68e83fbd38b73/CLUSTER_SUPPORT.md

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks @michael-valdron! /lgtm

@michael-valdron
Copy link
Member Author

/retest

@michael-valdron
Copy link
Member Author

/retest

@codecov
Copy link

codecov bot commented Apr 19, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (d69e00a) 22.72% compared to head (1c3d393) 22.72%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #42   +/-   ##
=======================================
  Coverage   22.72%   22.72%           
=======================================
  Files          23       23           
  Lines        1307     1307           
=======================================
  Hits          297      297           
  Misses        995      995           
  Partials       15       15           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@michael-valdron
Copy link
Member Author

/retest

1 similar comment
@michael-valdron
Copy link
Member Author

/retest

Signed-off-by: Michael Valdron <mvaldron@redhat.com>
Signed-off-by: Michael Valdron <mvaldron@redhat.com>
Signed-off-by: Michael Valdron <mvaldron@redhat.com>
@kim-tsao
Copy link
Contributor

kim-tsao commented May 2, 2023

/retest-required

Signed-off-by: Michael Valdron <mvaldron@redhat.com>
@openshift-ci openshift-ci bot removed the lgtm label May 8, 2023
@michael-valdron
Copy link
Member Author

/retest


- Go 1.19.x
- Docker / Podman
- Operator SDK 1.28.x
Copy link
Contributor

Choose a reason for hiding this comment

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

I wonder if we should tie in the kubernetes version here somehow since the operator sdk supports a specific version. https://sdk.operatorframework.io/docs/upgrading-sdk-version. Maybe have a subsection and a list of things to consider when we move up openshift and kube versions?

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe have a subsection and a list of things to consider when we move up openshift and kube versions?

I include some references the this guide in the latest commit, I'll add this list of required actions under the Operator SDK subsection of CLUSTER_SUPPORT.md.

…irements of Kubernetes

Signed-off-by: Michael Valdron <mvaldron@redhat.com>
…ER_SUPPORT.md

Signed-off-by: Michael Valdron <mvaldron@redhat.com>
@michael-valdron
Copy link
Member Author

/retest

@michael-valdron
Copy link
Member Author

/retest

5 similar comments
@michael-valdron
Copy link
Member Author

/retest

@michael-valdron
Copy link
Member Author

/retest

@michael-valdron
Copy link
Member Author

/retest

@michael-valdron
Copy link
Member Author

/retest

@michael-valdron
Copy link
Member Author

/retest

@openshift-ci openshift-ci bot added the lgtm label May 25, 2023
@openshift-ci
Copy link

openshift-ci bot commented May 25, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kim-tsao, michael-valdron

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:
  • OWNERS [kim-tsao,michael-valdron]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@michael-valdron michael-valdron merged commit dea070a into devfile:main May 26, 2023
thepetk pushed a commit to thepetk/devfile-registry-operator that referenced this pull request Aug 20, 2024
* deployment requirements added to README.

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* development requirements added.

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* ENVTEST K8S version updated.

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* matrix doc on container orchestration systems support added

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* add documentation on updating the Operator SDK and tie it to the requirements of Kubernetes

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* list of required actions for updating the Operator SDK added to CLUSTER_SUPPORT.md

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

---------

Signed-off-by: Michael Valdron <mvaldron@redhat.com>
Signed-off-by: thepetk <thepetk@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants