Skip to content

Commit b70158b

Browse files
Remove completed TODO
1 parent de60807 commit b70158b

1 file changed

Lines changed: 4 additions & 35 deletions

File tree

rust/operator-binary/src/controller/build/node_config.rs

Lines changed: 4 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -15,47 +15,16 @@ use crate::{
1515

1616
pub const CONFIGURATION_FILE_OPENSEARCH_YML: &str = "opensearch.yml";
1717

18-
// TODO Document how to enter config_overrides of various types, e.g. string, list, boolean,
19-
// object, ...
20-
21-
// Configuration file format
22-
//
23-
// This is not well documented.
24-
//
25-
// A list setting can be written as
26-
// - a comma-separated list, e.g.
27-
// ```
28-
// setting: a,b,c
29-
// ```
30-
// Commas in the values cannot be escaped.
31-
// - a JSON list, e.g.
32-
// ```
33-
// setting: ["a", "b", "c"]
34-
// ```
35-
// - a YAML list, e.g.
36-
// ```
37-
// setting:
38-
// - a
39-
// - b
40-
// - c
41-
// ```
42-
// - a (legacy) flat list, e.g.
43-
// ```
44-
// setting.0: a
45-
// setting.1: b
46-
// setting.2: b
47-
// ```
48-
4918
/// type: string
5019
pub const CONFIG_OPTION_CLUSTER_NAME: &str = "cluster.name";
5120

52-
/// type: list of strings
21+
/// type: (comma-separated) list of strings
5322
pub const CONFIG_OPTION_DISCOVERY_SEED_HOSTS: &str = "discovery.seed_hosts";
5423

5524
/// type: string
5625
pub const CONFIG_OPTION_DISCOVERY_TYPE: &str = "discovery.type";
5726

58-
/// type: list of strings
27+
/// type: (comma-separated) list of strings
5928
pub const CONFIG_OPTION_INITIAL_CLUSTER_MANAGER_NODES: &str =
6029
"cluster.initial_cluster_manager_nodes";
6130

@@ -65,10 +34,10 @@ pub const CONFIG_OPTION_NETWORK_HOST: &str = "network.host";
6534
/// type: string
6635
pub const CONFIG_OPTION_NODE_NAME: &str = "node.name";
6736

68-
/// type: list of strings
37+
/// type: (comma-separated) list of strings
6938
pub const CONFIG_OPTION_NODE_ROLES: &str = "node.roles";
7039

71-
/// type: list of strings
40+
/// type: (comma-separated) list of strings
7241
pub const CONFIG_OPTION_PLUGINS_SECURITY_NODES_DN: &str = "plugins.security.nodes_dn";
7342

7443
pub struct NodeConfig {

0 commit comments

Comments
 (0)