forked from d2iq-archive/kubeaddons-kommander
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add short term guideance to readme (d2iq-archive#5)
* docs: add short term guideance to readme * add release notes
- Loading branch information
1 parent
39879ee
commit 9b711d8
Showing
1 changed file
with
14 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,17 @@ | ||
# Kommander Addon Repository | ||
|
||
This is a [kubernetes addon](https://github.com/mesosphere/kubeaddons) repository which contains [Kommander](https://github.com/mesosphere/kommander) related addon applications. | ||
|
||
# Updating Kommander Addon | ||
|
||
**This section is only intended for short term guideance and might not be/stay 100% accurate, please get rid of whatever you see that seems wrong.** | ||
**this repo follows (mostly?) the same rules as https://github.com/mesosphere/kubernetes-base-addons - so please check readme files over there** | ||
|
||
to update kommander chart, _rename_ current revision and update the file as needed (usualy just chart version). | ||
in case we need to support multiple versions at the same time, its a good idea to use directories for it (1.x, 2.x, maybe even 1.1.x and 1.2.x if necessary, we can rename directories as needed). supporting multiple revisions at the same time shouldnt be necessary for kommander at this point. | ||
|
||
# Releasing Kommander Addon | ||
|
||
**same caveat as above, releas eprocess is being defined in https://github.com/mesosphere/kubernetes-base-addons currently.** | ||
|
||
current thinking is to have branches per supported kommander version (1.x, 2.x,…) and release tags that follow a k8s based scheme `<stable|beta>-<k8s-version>-<kommander-version>` (e.g. `stable-1.16-1.0.0`). this means for every release of kommander, there are (usually) three release tags (we support k8s n-2 versions). |