-
Notifications
You must be signed in to change notification settings - Fork 22
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
Conversation
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 |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @michael-valdron! /lgtm
/retest |
/retest |
Codecov ReportPatch and project coverage have no change.
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. |
cdaa700
to
7ca5303
Compare
/retest |
1 similar comment
/retest |
Signed-off-by: Michael Valdron <[email protected]>
Signed-off-by: Michael Valdron <[email protected]>
Signed-off-by: Michael Valdron <[email protected]>
7ca5303
to
b72aaf8
Compare
/retest-required |
Signed-off-by: Michael Valdron <[email protected]>
/retest |
|
||
- Go 1.19.x | ||
- Docker / Podman | ||
- Operator SDK 1.28.x |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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 <[email protected]>
…ER_SUPPORT.md Signed-off-by: Michael Valdron <[email protected]>
/retest |
/retest |
5 similar comments
/retest |
/retest |
/retest |
/retest |
/retest |
[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:
Approvers can indicate their approval by writing |
* deployment requirements added to README. Signed-off-by: Michael Valdron <[email protected]> * development requirements added. Signed-off-by: Michael Valdron <[email protected]> * ENVTEST K8S version updated. Signed-off-by: Michael Valdron <[email protected]> * matrix doc on container orchestration systems support added Signed-off-by: Michael Valdron <[email protected]> * add documentation on updating the Operator SDK and tie it to the requirements of Kubernetes Signed-off-by: Michael Valdron <[email protected]> * list of required actions for updating the Operator SDK added to CLUSTER_SUPPORT.md Signed-off-by: Michael Valdron <[email protected]> --------- Signed-off-by: Michael Valdron <[email protected]> Signed-off-by: thepetk <[email protected]>
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:
Documentation
How to test changes / Special notes to the reviewer: