summaryrefslogtreecommitdiffstats
path: root/kubernetes/dcaegen2/components/dcae-cloudify-manager/README.md
diff options
context:
space:
mode:
authorguillaume.lambert <guillaume.lambert@orange.com>2021-09-14 12:32:24 +0200
committerGuillaume Lambert <guillaume.lambert@orange.com>2021-09-26 19:58:12 +0000
commit30ec390479c9b7eeeaa90f036be02162c29ae918 (patch)
tree90d3bd9dc27e4c2c7b16da8023094077d867de01 /kubernetes/dcaegen2/components/dcae-cloudify-manager/README.md
parentc08270e3213309dac5d6dada14c1d09410921be7 (diff)
[COMMON] Add and run pre-commit linters via tox
- create a .pre-commit-config.yaml configuration file with * gitlint * trailing blanks linter * tabs removal linter - exclude .git folder from it - exclude Makefiles since tabs are mandatory by default in them - create a tox pre-commit profile to run it from tox note gitlint is not runnable at this pre-commit stage - create pre-commit-install and pre-commit-uninstall tox profiles to (un)install hooks locally and (un)perform tests at each "git commit" call (i.e. without calling manually the pre-commit tox profile) - precise pre-commit stages/types in the pre-commit configuration file so that hooks are installed correctly. This avoids messages about skipped tests when they are run at a wrong stage. Issue-ID: OOM-2643 Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com> Change-Id: Ie95bb4f6f90be80b05a1398973caffeff7936881
Diffstat (limited to 'kubernetes/dcaegen2/components/dcae-cloudify-manager/README.md')
-rw-r--r--kubernetes/dcaegen2/components/dcae-cloudify-manager/README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/kubernetes/dcaegen2/components/dcae-cloudify-manager/README.md b/kubernetes/dcaegen2/components/dcae-cloudify-manager/README.md
index c995a62c09..fa2d597caa 100644
--- a/kubernetes/dcaegen2/components/dcae-cloudify-manager/README.md
+++ b/kubernetes/dcaegen2/components/dcae-cloudify-manager/README.md
@@ -18,15 +18,15 @@
# DCAE Cloudify Manager Chart
-This chart is used to deploy a containerized version of
+This chart is used to deploy a containerized version of
[Cloudify Manager](http://docs.getcloudify.org/4.3.0/intro/cloudify-manager/),
-the orchestration tool used by DCAE. DCAE uses Cloudify Manager ("CM") to
+the orchestration tool used by DCAE. DCAE uses Cloudify Manager ("CM") to
deploy the rest of the DCAE platform as well to deploy DCAE monitoring and
analytics services dynamically, in response to network events such as VNF startups.
-Deployment of CM is the first of two steps in deploying DCAE into ONAP. After this chart
-brings up CM, a second chart (the "bootstrap" chart) installs some plugin extensions onto CM
-and uses CM to deploy some DCAE components.
+Deployment of CM is the first of two steps in deploying DCAE into ONAP. After this chart
+brings up CM, a second chart (the "bootstrap" chart) installs some plugin extensions onto CM
+and uses CM to deploy some DCAE components.
## Prerequisites
The chart requires one Kubernetes secret to be available in the namespace where it is
@@ -37,10 +37,10 @@ being deployed:
## DCAE Namespace
DCAE will use CM deploy a number of containers into the ONAP Kubernetes cluster. In a production
environment, DCAE's dynamic deployment of monitoring and analytics services could result in dozens
-of containers being launched. This chart allows the configuration, through the `dcae_ns` property
+of containers being launched. This chart allows the configuration, through the `dcae_ns` property
in the `values.yaml` of a separate namespace used by CM when it needs to deploy containers into
Kubernetes. If `dcae_ns` is set, this chart will:
- - create the namespace.
+ - create the namespace.
- create the Docker registry key secret in the namespace.
- create some Kubernetes `Services` (of the `ExternalName` type) to map some addresses from the common namespace into the DCAE namespace.