Skip to content

Commit

Permalink
Update carvel docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jvalkeal committed Nov 21, 2021
1 parent 8e745d8 commit edcc28a
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 4 deletions.
19 changes: 15 additions & 4 deletions src/carvel/docs/README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@ ifdef::env-github[]
endif::[]
:servers: link:servers.adoc[Servers]
:examples: link:examples.adoc[Examples]
:options: link:configuration-options.adoc[Configuration Options]
:debug: link:debug.adoc[Debug]
ifndef::env-github[]
:servers: <<servers>>
:examples: <<examples>>
:options: <<options>>
:debug: <<debug>>
endif::[]

Expand Down Expand Up @@ -84,6 +86,12 @@ comes with a price of maintaining created resources manually. Essentially this
means you need to be aware of what resources are created if those needs
to be cleared or maintained in a future.

All resources are created at a same time and if databases are deployed
as services, you may see _dataflow_ and _skipper_ servers to restart
if cluster didn't bring up databases up fast enough. With _carvel_ this
is handled by services waiting reconciliation before deploying dependant
services.

[[deployment-kapp]]
==== Deploy via kapp
Essentially much like deploying with _kubectl_ but uses _kapp_ spesific
Expand All @@ -99,7 +107,7 @@ go with plain _kubernetes_ yaml files and full control over it.
Takes use of a _carvel_ package and deploys via controller with given options.

With _kapp-controller_ you introduce a concept of a _carvel package_ and
_package repository_ which gives even higher level of a deployment into
_carvel repository_ which gives even higher level of a deployment into
a cluster. Essentially you no longer work with low level yaml files but
work with configuration options which drives templating of a _kubernetes_
resources. Furthermore when deleting something from a cluster, you're no
Expand All @@ -121,12 +129,15 @@ managing a _worker cluster_. If you don't want to down this route it
may be easier to work with lower level deployment options mentioned above.
====

=== Configuration Options
For possible configuration options for carvel, see {options}.

=== Configure Servers
More info to configure servers see {servers}.
More info to configure _dataflow_ and _skipper_ servers see {servers}.

=== Binder and Database
Whether you want to use _rabbit_ or a _kafka_ as a binder and _mariadb_ or
a _postgres_ as a database we provided easy deployment which steps away when
Whether you want to use _rabbit_ or _kafka_ as a binder and _mariadb_ or
_postgres_ as a database we provide easy deployment which steps away when
external services are defined.

==== Use Deployed Services
Expand Down
1 change: 1 addition & 0 deletions src/carvel/docs/configuration-options.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ yaml document.
- <<configuration-options-scdf.feature.monitoring.prometheusRsocketProxy.image.tag>>
- <<configuration-options-scdf.feature.monitoring.prometheusRsocketProxy.image.digest>>

[[options]]
=== Options

[[configuration-options-scdf.registry.secret.ref]]`scdf.registry.secret.ref`::
Expand Down

0 comments on commit edcc28a

Please sign in to comment.