Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: add docs on druid_cr.md and fix typos #23

Merged
merged 2 commits into from
Mar 9, 2023
Merged

chore: add docs on druid_cr.md and fix typos #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
830f8c4
chore: add docs on druid_cr.md and fix typos
cyril-corbon Mar 9, 2023
2bec97a
chore: add prod advice
cyril-corbon Mar 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@

---

:warning: You won't find any documentation about druid itself in this repositoy.
If you need details about how to architecutre your druid cluster you can consult theses documentations:
:warning: You won't find any documentation about druid itself in this repository.
If you need details about how to architecture your druid cluster you can consult theses documentations:

* [Druid introduction](<https://druid.apache.org/docs/latest/design/index.html>)
* [Druid architecture](https://druid.apache.org/docs/latest/design/architecture.html)
Expand Down
1 change: 0 additions & 1 deletion docs/dev_doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
- Golang 1.19+
- Kubebuilder 2.3.1+


## Running Operator Locally

- make run
Expand Down
15 changes: 10 additions & 5 deletions docs/druid_cr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,16 @@
- The operator supports both deployments and statefulsets for druid Nodes. ```kind``` can be specified in the druid NodeSpec's to ```Deployment``` / ```StatefulSet```.
- ```NOTE: The default behavior shall provision all the nodes as statefulsets.```

- The following are cluster scoped and common to all the druid nodes.
- The following are cluster scoped and common to all the druid nodes.

```
```yaml
spec:
# Image for druid, Required Key
image: apache/incubator-druid:0.16.0-incubating
# Enable rolling deploy for druid, not required but suggested for production setup
# more information in features.md and in druid documentation
# http://druid.io/docs/latest/operations/rolling-updates.html
rollingDeploy: true
# Image for druid, Required Key
image: apache/druid:25.0.0
....
# Optionally specify image for all nodes. Can be specify on nodes also
# imagePullSecrets:
Expand All @@ -36,14 +40,15 @@ spec:
jvm.options: |-
...
# log4j.config common for all druid nodes

log4j.config: |-
# common runtime properties for all druid nodes
common.runtime.properties: |
```

- The following are specific to a node.

```
```yaml
nodes:
# String value, can be anything to define a node name.
brokers:
Expand Down