Documentation for k8s podspec with examples
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Canonical Juju |
Expired
|
High
|
Unassigned |
Bug Description
Hello,
Starting with a new k8s charm with the operator framework, I was a bit confused by the lack of documentation regarding the podspec "spec" itself.
Here is what I found so far:
* There is currently 3 version of this podspec. v3 is the current one (30th July 2020)
* This post is a description of the v1 : https:/
* This post seems to summarize the change brought to the v2 : https:/
* This post is about v3 podspec : https:/
What I found hard is that there is not a central place for all the spec version.
Even more so that the first post is not found when looking for "podspec spec" in discourse but by the reply in the second post.
The mariadb-k8s charm example seems to provide a podspec v1 : https:/
From there, you need to basically compile yourself the various new capabilities and concept fo the v2 and v3 (including the switch from "config" to "envConfig" and "files" to "volumeConfig").
Would it be possible to have a single dummy podspec YAML example per version with comments somewhere and also some practical example on how to couple them with the "kubernetesReso
A practical example is the Mattermost charm : https:/
Thanks !
Changed in juju: | |
milestone: | 3.0.0 → 3.0.1 |
Changed in juju: | |
milestone: | 3.0.1 → 3.0.2 |
Changed in juju: | |
milestone: | 3.0.2 → 3.0.3 |
Changed in juju: | |
milestone: | 3.0.3 → 3.0.4 |
The sample mariadb charm is very minimal and only needs features for v1 - there's been no need to update it to use v2 or v3 features.
It's definitely a known issue and there's ongoing work to consolidate all of the k8s material off discourse into more cohesive Juu-k8s documentation, including a more fully featured sample charm etc. Tim is doing the heavy lifting so far so I'll assign the bug to him.