Skip to content

Commit 27f2b70

Browse files
committed
Some docs
1 parent 5f4daa5 commit 27f2b70

3 files changed

Lines changed: 11 additions & 8 deletions

File tree

extra/crds.yaml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,9 @@ spec:
8989
- configMap
9090
type: object
9191
metadataDatabase:
92-
description: TODO docs
92+
description: |-
93+
Configure the database where the Hive metastore stores all it's internal metadata, such
94+
as schema and tables.
9395
oneOf:
9496
- required:
9597
- postgresql
@@ -99,7 +101,7 @@ spec:
99101
- derby
100102
properties:
101103
derby:
102-
description: TODO docs
104+
description: Use an Apache Derby database
103105
properties:
104106
location:
105107
description: |-
@@ -114,7 +116,7 @@ spec:
114116
type: object
115117
mysql:
116118
description: |-
117-
TODO docs
119+
Use a MySQL database.
118120
119121
Please note that - due to license issues - we don't ship the mysql driver, you need to add
120122
it it yourself.
@@ -153,7 +155,7 @@ spec:
153155
- host
154156
type: object
155157
postgresql:
156-
description: TODO docs
158+
description: Use a PostgreSQL database
157159
properties:
158160
credentialsSecret:
159161
description: |-

rust/operator-binary/src/crd/databases.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,17 @@ use stackable_operator::{
1212
#[derive(Clone, Debug, Deserialize, JsonSchema, PartialEq, Serialize)]
1313
#[serde(rename_all = "camelCase")]
1414
pub enum MetadataDatabaseConnection {
15-
/// TODO docs
15+
/// Use a PostgreSQL database
1616
Postgresql(PostgresqlConnection),
1717

18-
/// TODO docs
18+
/// Use a MySQL database.
1919
///
2020
/// Please note that - due to license issues - we don't ship the mysql driver, you need to add
2121
/// it it yourself.
2222
/// See <https://docs.stackable.tech/home/stable/hive/usage-guide/database-driver/> for details.
2323
Mysql(MysqlConnection),
2424

25-
/// TODO docs
25+
/// Use an Apache Derby database
2626
Derby(DerbyConnection),
2727
// We don't support generic (yet?), as we need to tell the metastore the `--dbtype` on startup,
2828
// which is not known for generic connection.

rust/operator-binary/src/crd/mod.rs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,8 @@ pub mod versioned {
161161
/// Learn more in the [Hive authorization usage guide](DOCS_BASE_URL_PLACEHOLDER/hive/usage-guide/security#authorization).
162162
pub authorization: Option<security::AuthorizationConfig>,
163163

164-
/// TODO docs
164+
/// Configure the database where the Hive metastore stores all it's internal metadata, such
165+
/// as schema and tables.
165166
pub metadata_database: MetadataDatabaseConnection,
166167

167168
/// HDFS connection specification.

0 commit comments

Comments
 (0)