소스 검색

add a lot of documentation

Grega Bremec 2 년 전
부모
커밋
0a0fbb8cd3
2개의 변경된 파일40개의 추가작업 그리고 1개의 파일을 삭제
  1. 39 0
      README.adoc
  2. 1 1
      deployment/exporter/custom/kustomization.yml

+ 39 - 0
README.adoc

@@ -20,8 +20,47 @@ the way in order to keep the disk space utilisation as low as possible.
 
 == OpenShift Deployment ==
 
+The easiest? Just use `Kustomize` to deploy existing resource definitions from
+the `exporter` manifest in `deployment/`:
+
+[subs=+quotes]
+------
+$ *oc apply -k ./deployment/exporter/base/*
+------
+
+The above will create everything in the `exporter` project. If you need to
+change that, or some other settings, feel free to have a look at the `custom`
+kustomization next to `base`, then apply it instead of the base set of
+resources.
+
+[subs=+quotes]
+------
+$ *cat deployment/exporter/custom/use-custom-namespace.yml*
+apiVersion: builtin
+kind: NamespaceTransformer
+metadata:
+  namespace: *my-very-own-namespace*
+setRoleBindingSubjects: allServiceAccounts
+fieldSpecs:
+  - path: metadata/name
+    kind: Namespace
+
+$ *oc apply -k ./deployment/exporter/custom/*
+------
+
+You should have Prometheus deployed somewhere prior to that though, so you
+might want to have a look at least at the kustomizations for the `integrate`
+manifest in order to target the right places.
+
 TBD
 
+If you still need to deploy Prometheus, there is a sample manifest in there as
+well. Two, actually. One to deploy the Prometheus and Grafana operators (you
+won't believe it, it's called `operators`), and once those are running, you can
+use the other one (called very innovatively `prometheus`) to deploy their
+actual instances. That, will also target the `prometheus` OpenShift project, so
+kustomize away if that's not what you want.
+
 == Standalone Containers ==
 
 Start the composition.

+ 1 - 1
deployment/exporter/custom/kustomization.yml

@@ -1,7 +1,7 @@
 apiVersion: kustomize.config.k8s.io/v1beta1
 kind: Kustomization
 resources:
-  - ../../base/
+  - ../base/
 transformers:
   # Use a custom project for all the components.
   - use-custom-namespace.yml