some tech docs #652
some tech docs #652
Conversation
Codecov Report
@@ Coverage Diff @@
## master #652 +/- ##
=======================================
Coverage 81.39% 81.39%
=======================================
Files 114 114
Lines 3869 3869
Branches 95 95
=======================================
Hits 3149 3149
Misses 720 720 Continue to review full report at Codecov.
|
docs-tech/bakery-architecture.md
Outdated
|
|
||
| ## Baker and Interaction CRDs | ||
|
|
||
| The 2 CRDs that we have contain all the requirements of the components to be deployed, like the amount of cluster nodes |
There was a problem hiding this comment.
'amount' is used with uncountable nouns, 'number' should be used instead
| Also the specification of the CRDs can be found [here for Baker](../bakery-integration-tests/src/test/resources/kubernetes/crd/crd-baker.yaml) | ||
| and [here for Interaction](../bakery-integration-tests/src/test/resources/kubernetes/crd/crd-interaction.yaml) | ||
|
|
||
| ### Baker Manifests |
There was a problem hiding this comment.
Here and 3 sections below: just one long sentence per section.
Splitting it to shorter sentences and avoiding passive voice where possible would improve readability.
docs-tech/bakery-architecture.md
Outdated
| ## Configuration mounting | ||
|
|
||
| As part of the CRDs of both Bakers and Interactions, one can add the name of a secret and/or a configmap to mount configuration | ||
| within the Bakers and Interaction pods, this is used for example to configure per environment cassandra connectivity or |
There was a problem hiding this comment.
inconsistent capitalisation, baker vs Baker, cassandra vs Cassandra.
docs-tech/bakery-architecture.md
Outdated
|
|
||
| ## Baker Clients | ||
|
|
||
| Baker clients can either consume the HTTP api or use our published bakery-baker-client library to use a baker scala/java |
There was a problem hiding this comment.
perhaps worth adding that the APIs exposed by Baker are 'naked' in the sense that doesn't provide any authn/z
and this is up to the implementor to arrange
docs-tech/bakery-architecture.md
Outdated
| changes and deletions of such CRDs, so that the state of the namespace always matches the textual specifications. | ||
|
|
||
| The Bakery Controller also creates Kubernetes ConfigMaps which we call "Manifests", which are outcome of the creation of | ||
| a CRD, these are config maps used as internal mechanisms to expose semantic data about the deployed components, more of |
There was a problem hiding this comment.
perhaps a minor point, just for consistency:
CRD is Custom Resource Definition, that is - the metadata, the schema to which CR (Custom Resource) must adhere
therefore, what is being created by controller is not a CRD (CRD has already been created in the cluster) but just a CR or custom resource
No description provided.