doc/user/migrating-existing-apis.md: document API version migra… #1680
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
estroz
added
the
kind/documentation
estroz
requested review from
jmrodri,
joelanford,
shawn-hurley,
fabianvf,
AlexNPavel,
lilic,
hasbro17 and
theishshah
openshift-ci-robot
added
the
size/L
hasbro17
reviewed
Jul 22, 2019
hasbro17
reviewed
Jul 22, 2019
awgreene
requested changes
Jul 29, 2019
| Kubernetes APIs are assumed to evolve over time, hence the well-defined API [versioning scheme][k8s-versioning]. Upgrading your operator's APIs can be a non-trivial task, one that will involve changing quite a few source files and manifests. This document aims to identify the complexities of migrating an operator project's API using examples from existing operators. | ||
|
|
||
| While examples in this guide follow particular types of API migrations, most of the documented migration steps can be generalized to all migration types. A thorough discussion of migration types for a particular project type (Go, Ansible, Helm) is found at the end of each project type's section. | ||
|
|
There was a problem hiding this comment.
It may be beneficial to start with a happy case where the GVK contains a single kind.
There was a problem hiding this comment.
You mean do a walkthrough of a migration with a single kind?
There was a problem hiding this comment.
Correct - the first case is a bit more difficult to consume when compared to the case outlined here.
There was a problem hiding this comment.
This case should be added in a follow-up PR since there are a lot of changes here already.
joelanford
approved these changes
Aug 9, 2019
openshift-ci-robot
added
lgtm
estroz
force-pushed
the
doc-api-changes
branch
from
9f21ac8 to
2ae7e53
Compare
…wing kubernetes API conventions
…ge conversion wording
estroz
force-pushed
the
doc-api-changes
branch
from
2ae7e53 to
faa1efa
Compare
|
/test e2e-aws-subcommand |
|
Sorry for the hold up. I'll finish my review on this hopefully in a day or so. |
hasbro17
reviewed
Sep 19, 2019
hasbro17
reviewed
Sep 19, 2019
hasbro17
reviewed
Sep 19, 2019
hasbro17
approved these changes
Sep 19, 2019
Co-Authored-By: Haseeb Tariq <[email protected]>
|
New changes are detected. LGTM label has been removed. |
|
/test e2e-aws-go |
|
/test e2e-aws-ansible |
1 similar comment
|
/test e2e-aws-ansible |
estroz
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of the change: From #1541:
Note: for Go projects only. Ansible and Helm have TODO's.
Motivation for the change: see #1541.
Closes #1541
PTAL @awgreene @dmesser