deploy: c10ec52

api-reference/cassandra.html

@@ -2149,10 +2149,12 @@ <h3 id="spec.userConfig.cassandra">cassandra<a class="headerlink" href="#spec.us
 <li><a href="#spec.userConfig.cassandra.batch_size_fail_threshold_in_kb-property" name="spec.userConfig.cassandra.batch_size_fail_threshold_in_kb-property"><code>batch_size_fail_threshold_in_kb</code></a> (integer, Minimum: 1, Maximum: 1000000). Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default.</li>
 <li><a href="#spec.userConfig.cassandra.batch_size_warn_threshold_in_kb-property" name="spec.userConfig.cassandra.batch_size_warn_threshold_in_kb-property"><code>batch_size_warn_threshold_in_kb</code></a> (integer, Minimum: 1, Maximum: 1000000). Log a warning message on any multiple-partition batch size exceeding this value.5kb per batch by default.Caution should be taken on increasing the size of this thresholdas it can lead to node instability.</li>
 <li><a href="#spec.userConfig.cassandra.datacenter-property" name="spec.userConfig.cassandra.datacenter-property"><code>datacenter</code></a> (string, MaxLength: 128). Name of the datacenter to which nodes of this service belong. Can be set only when creating the service.</li>
+<li><a href="#spec.userConfig.cassandra.read_request_timeout_in_ms-property" name="spec.userConfig.cassandra.read_request_timeout_in_ms-property"><code>read_request_timeout_in_ms</code></a> (integer, Minimum: 1000, Maximum: 10000). How long the coordinator waits for read operations to complete before timing it out. 5 seconds by default.</li>
+<li><a href="#spec.userConfig.cassandra.write_request_timeout_in_ms-property" name="spec.userConfig.cassandra.write_request_timeout_in_ms-property"><code>write_request_timeout_in_ms</code></a> (integer, Minimum: 1000, Maximum: 10000). How long the coordinator waits for write requests to complete with at least one node in the local datacenter. 2 seconds by default.</li>
 </ul>
 <h3 id="spec.userConfig.ip_filter">ip_filter<a class="headerlink" href="#spec.userConfig.ip_filter" title="Permanent link">&para;</a></h3>
 <p><em>Appears on <a href="#spec.userConfig"><code>spec.userConfig</code></a>.</em></p>
-<p>Allow incoming connections from CIDR address block, e.g. <code>10.20.0.0/16</code>.</p>
+<p>CIDR address block, either as a string, or in a dict with an optional description field.</p>
 <p><strong>Required</strong></p>
 <ul>
 <li><a href="#spec.userConfig.ip_filter.network-property" name="spec.userConfig.ip_filter.network-property"><code>network</code></a> (string, MaxLength: 43). CIDR address block.</li>

api-reference/clickhouse.html

@@ -2135,7 +2135,7 @@ <h2 id="spec.userConfig">userConfig<a class="headerlink" href="#spec.userConfig"
 </ul>
 <h3 id="spec.userConfig.ip_filter">ip_filter<a class="headerlink" href="#spec.userConfig.ip_filter" title="Permanent link">&para;</a></h3>
 <p><em>Appears on <a href="#spec.userConfig"><code>spec.userConfig</code></a>.</em></p>
-<p>Allow incoming connections from CIDR address block, e.g. <code>10.20.0.0/16</code>.</p>
+<p>CIDR address block, either as a string, or in a dict with an optional description field.</p>
 <p><strong>Required</strong></p>
 <ul>
 <li><a href="#spec.userConfig.ip_filter.network-property" name="spec.userConfig.ip_filter.network-property"><code>network</code></a> (string, MaxLength: 43). CIDR address block.</li>

api-reference/clickhousedatabase.html

@@ -1841,9 +1841,12 @@ <h2 id="spec">spec<a class="headerlink" href="#spec" title="Permanent link">&par
 <p><strong>Optional</strong></p>
 <ul>
 <li><a href="#spec.authSecretRef-property" name="spec.authSecretRef-property"><code>authSecretRef</code></a> (object). Authentication reference to Aiven token in a secret. See below for <a href="#spec.authSecretRef">nested schema</a>.</li>
-<li><a href="#spec.databaseName-property" name="spec.databaseName-property"><code>databaseName</code></a> (string, Immutable, MaxLength: 63). Specifies the Clickhouse database name. Defaults to <code>metadata.name</code> if omitted.
-Note: <code>metadata.name</code> is ASCII-only. For UTF-8 names, use <code>spec.databaseName</code>, but ASCII is advised for compatibility.</li>
+<li><a href="#spec.databaseName-property" name="spec.databaseName-property"><code>databaseName</code></a> (string, Immutable, MaxLength: 63). Specifies the Clickhouse database name. Defaults to <code>metadata.name</code> if omitted.</li>
 </ul>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p><code>metadata.name</code> is ASCII-only. For UTF-8 names, use <code>spec.databaseName</code>, but ASCII is advised for compatibility.</p>
+</div>
 <h2 id="spec.authSecretRef">authSecretRef<a class="headerlink" href="#spec.authSecretRef" title="Permanent link">&para;</a></h2>
 <p><em>Appears on <a href="#spec"><code>spec</code></a>.</em></p>
 <p>Authentication reference to Aiven token in a secret.</p>

api-reference/clickhousegrant.html

@@ -2034,8 +2034,8 @@ <h2 id="usage-examples">Usage examples<a class="headerlink" href="#usage-example
 <h2 id="ClickhouseGrant">ClickhouseGrant<a class="headerlink" href="#ClickhouseGrant" title="Permanent link">&para;</a></h2>
 <p>ClickhouseGrant is the Schema for the ClickhouseGrants API</p>
 <div class="admonition warning">
-<p class="admonition-title">Ambiguity in the <code>GRANT</code> syntax</p>
-<p>Due to <a href="https://github.com/aiven/ospo-tracker/issues/350">an ambiguity</a> in the <code>GRANT</code> syntax in Clickhouse, you should not have users and roles with the same name. It is not clear if a grant refers to the user or the role.</p>
+<p class="admonition-title">Warning</p>
+<p>Due to the way ClickHouse operates, updating this resource first revokes the existing privileges.</p>
 </div>
 <p><strong>Required</strong></p>
 <ul>
@@ -2068,33 +2068,41 @@ <h2 id="spec.authSecretRef">authSecretRef<a class="headerlink" href="#spec.authS
 </ul>
 <h2 id="spec.privilegeGrants">privilegeGrants<a class="headerlink" href="#spec.privilegeGrants" title="Permanent link">&para;</a></h2>
 <p><em>Appears on <a href="#spec"><code>spec</code></a>.</em></p>
-<p>Configuration to grant a privilege. Privileges not in the manifest are revoked. Existing privileges are retained; new ones are granted.</p>
+<p>PrivilegeGrant represents the privileges to be granted to users or roles.
+<a href="https://clickhouse.com/docs/en/sql-reference/statements/grant#granting-privilege-syntax">See</a>.</p>
 <p><strong>Required</strong></p>
 <ul>
 <li><a href="#spec.privilegeGrants.database-property" name="spec.privilegeGrants.database-property"><code>database</code></a> (string). The database that the grant refers to.</li>
 <li><a href="#spec.privilegeGrants.grantees-property" name="spec.privilegeGrants.grantees-property"><code>grantees</code></a> (array of objects, MinItems: 1). List of grantees (users or roles) to grant the privilege to. See below for <a href="#spec.privilegeGrants.grantees">nested schema</a>.</li>
 <li><a href="#spec.privilegeGrants.privileges-property" name="spec.privilegeGrants.privileges-property"><code>privileges</code></a> (array of strings). The privileges to grant, i.e. <code>INSERT</code>, <code>SELECT</code>.
-See <a href="https://clickhouse.com/docs/en/sql-reference/statements/grant#assigning-role-syntax">https://clickhouse.com/docs/en/sql-reference/statements/grant#assigning-role-syntax</a>.</li>
+<a href="https://clickhouse.com/docs/en/sql-reference/statements/grant#assigning-role-syntax">See</a>.</li>
 </ul>
 <p><strong>Optional</strong></p>
 <ul>
 <li><a href="#spec.privilegeGrants.columns-property" name="spec.privilegeGrants.columns-property"><code>columns</code></a> (array of strings). The column that the grant refers to.</li>
 <li><a href="#spec.privilegeGrants.table-property" name="spec.privilegeGrants.table-property"><code>table</code></a> (string). The tables that the grant refers to. To grant a privilege on all tables in a database, omit this field instead of writing <code>table: "*"</code>.</li>
 <li><a href="#spec.privilegeGrants.withGrantOption-property" name="spec.privilegeGrants.withGrantOption-property"><code>withGrantOption</code></a> (boolean). If true, then the grantee (user or role) get the permission to execute the <code>GRANT</code> query.
 Users can grant privileges of the same scope they have and less.
-See <a href="https://clickhouse.com/docs/en/sql-reference/statements/grant#granting-privilege-syntax">https://clickhouse.com/docs/en/sql-reference/statements/grant#granting-privilege-syntax</a>.</li>
+<a href="https://clickhouse.com/docs/en/sql-reference/statements/grant#granting-privilege-syntax">See</a>.</li>
 </ul>
 <h3 id="spec.privilegeGrants.grantees">grantees<a class="headerlink" href="#spec.privilegeGrants.grantees" title="Permanent link">&para;</a></h3>
 <p><em>Appears on <a href="#spec.privilegeGrants"><code>spec.privilegeGrants</code></a>.</em></p>
-<p>List of grantees (users or roles) to grant the privilege to.</p>
+<p>Grantee represents a user or a role to which privileges or roles are granted.</p>
+<div class="admonition warning">
+<p class="admonition-title">Ambiguity in the <code>GRANT</code> syntax</p>
+<p>Due to <a href="https://github.com/aiven/ospo-tracker/issues/350">an ambiguity</a> in the GRANT syntax in ClickHouse,
+users and roles should not share the same name.
+It is unclear whether a grant applies to the user or the role.</p>
+</div>
 <p><strong>Optional</strong></p>
 <ul>
 <li><a href="#spec.privilegeGrants.grantees.role-property" name="spec.privilegeGrants.grantees.role-property"><code>role</code></a> (string).</li>
 <li><a href="#spec.privilegeGrants.grantees.user-property" name="spec.privilegeGrants.grantees.user-property"><code>user</code></a> (string).</li>
 </ul>
 <h2 id="spec.roleGrants">roleGrants<a class="headerlink" href="#spec.roleGrants" title="Permanent link">&para;</a></h2>
 <p><em>Appears on <a href="#spec"><code>spec</code></a>.</em></p>
-<p>Configuration to grant a role. Role grants not in the manifest are revoked. Existing role grants are retained; new ones are granted.</p>
+<p>RoleGrant represents the roles to be assigned to users or roles.
+<a href="https://clickhouse.com/docs/en/sql-reference/statements/grant#assigning-role-syntax">See</a>.</p>
 <p><strong>Required</strong></p>
 <ul>
 <li><a href="#spec.roleGrants.grantees-property" name="spec.roleGrants.grantees-property"><code>grantees</code></a> (array of objects, MinItems: 1). List of grantees (users or roles) to grant the privilege to. See below for <a href="#spec.roleGrants.grantees">nested schema</a>.</li>
@@ -2103,11 +2111,17 @@ <h2 id="spec.roleGrants">roleGrants<a class="headerlink" href="#spec.roleGrants"
 <p><strong>Optional</strong></p>
 <ul>
 <li><a href="#spec.roleGrants.withAdminOption-property" name="spec.roleGrants.withAdminOption-property"><code>withAdminOption</code></a> (boolean). If true, the grant is executed with <code>ADMIN OPTION</code> privilege.
-See <a href="https://clickhouse.com/docs/en/sql-reference/statements/grant#admin-option">https://clickhouse.com/docs/en/sql-reference/statements/grant#admin-option</a>.</li>
+<a href="https://clickhouse.com/docs/en/sql-reference/statements/grant#admin-option">See</a>.</li>
 </ul>
 <h3 id="spec.roleGrants.grantees">grantees<a class="headerlink" href="#spec.roleGrants.grantees" title="Permanent link">&para;</a></h3>
 <p><em>Appears on <a href="#spec.roleGrants"><code>spec.roleGrants</code></a>.</em></p>
-<p>List of grantees (users or roles) to grant the privilege to.</p>
+<p>Grantee represents a user or a role to which privileges or roles are granted.</p>
+<div class="admonition warning">
+<p class="admonition-title">Ambiguity in the <code>GRANT</code> syntax</p>
+<p>Due to <a href="https://github.com/aiven/ospo-tracker/issues/350">an ambiguity</a> in the GRANT syntax in ClickHouse,
+users and roles should not share the same name.
+It is unclear whether a grant applies to the user or the role.</p>
+</div>
 <p><strong>Optional</strong></p>
 <ul>
 <li><a href="#spec.roleGrants.grantees.role-property" name="spec.roleGrants.grantees.role-property"><code>role</code></a> (string).</li>

api-reference/clickhouseuser.html

@@ -1901,9 +1901,12 @@ <h2 id="spec">spec<a class="headerlink" href="#spec" title="Permanent link">&par
 <li><a href="#spec.authSecretRef-property" name="spec.authSecretRef-property"><code>authSecretRef</code></a> (object). Authentication reference to Aiven token in a secret. See below for <a href="#spec.authSecretRef">nested schema</a>.</li>
 <li><a href="#spec.connInfoSecretTarget-property" name="spec.connInfoSecretTarget-property"><code>connInfoSecretTarget</code></a> (object). Secret configuration. See below for <a href="#spec.connInfoSecretTarget">nested schema</a>.</li>
 <li><a href="#spec.connInfoSecretTargetDisabled-property" name="spec.connInfoSecretTargetDisabled-property"><code>connInfoSecretTargetDisabled</code></a> (boolean, Immutable). When true, the secret containing connection information will not be created, defaults to false. This field cannot be changed after resource creation.</li>
-<li><a href="#spec.username-property" name="spec.username-property"><code>username</code></a> (string, Immutable, MaxLength: 63). Name of the Clickhouse user. Defaults to <code>metadata.name</code> if omitted.
-Note: <code>metadata.name</code> is ASCII-only. For UTF-8 names, use <code>spec.username</code>, but ASCII is advised for compatibility.</li>
+<li><a href="#spec.username-property" name="spec.username-property"><code>username</code></a> (string, Immutable, MaxLength: 63). Name of the Clickhouse user. Defaults to <code>metadata.name</code> if omitted.</li>
 </ul>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p><code>metadata.name</code> is ASCII-only. For UTF-8 names, use <code>spec.username</code>, but ASCII is advised for compatibility.</p>
+</div>
 <h2 id="spec.authSecretRef">authSecretRef<a class="headerlink" href="#spec.authSecretRef" title="Permanent link">&para;</a></h2>
 <p><em>Appears on <a href="#spec"><code>spec</code></a>.</em></p>
 <p>Authentication reference to Aiven token in a secret.</p>

api-reference/grafana.html

@@ -2416,7 +2416,7 @@ <h3 id="spec.userConfig.external_image_storage">external_image_storage<a class="
 </ul>
 <h3 id="spec.userConfig.ip_filter">ip_filter<a class="headerlink" href="#spec.userConfig.ip_filter" title="Permanent link">&para;</a></h3>
 <p><em>Appears on <a href="#spec.userConfig"><code>spec.userConfig</code></a>.</em></p>
-<p>Allow incoming connections from CIDR address block, e.g. <code>10.20.0.0/16</code>.</p>
+<p>CIDR address block, either as a string, or in a dict with an optional description field.</p>
 <p><strong>Required</strong></p>
 <ul>
 <li><a href="#spec.userConfig.ip_filter.network-property" name="spec.userConfig.ip_filter.network-property"><code>network</code></a> (string, MaxLength: 43). CIDR address block.</li>

api-reference/kafka.html

@@ -2355,7 +2355,7 @@ <h2 id="spec.userConfig">userConfig<a class="headerlink" href="#spec.userConfig"
 </ul>
 <h3 id="spec.userConfig.ip_filter">ip_filter<a class="headerlink" href="#spec.userConfig.ip_filter" title="Permanent link">&para;</a></h3>
 <p><em>Appears on <a href="#spec.userConfig"><code>spec.userConfig</code></a>.</em></p>
-<p>Allow incoming connections from CIDR address block, e.g. <code>10.20.0.0/16</code>.</p>
+<p>CIDR address block, either as a string, or in a dict with an optional description field.</p>
 <p><strong>Required</strong></p>
 <ul>
 <li><a href="#spec.userConfig.ip_filter.network-property" name="spec.userConfig.ip_filter.network-property"><code>network</code></a> (string, MaxLength: 43). CIDR address block.</li>
@@ -2448,7 +2448,7 @@ <h3 id="spec.userConfig.kafka_connect_config">kafka_connect_config<a class="head
 </ul>
 <h3 id="spec.userConfig.kafka_connect_secret_providers">kafka_connect_secret_providers<a class="headerlink" href="#spec.userConfig.kafka_connect_secret_providers" title="Permanent link">&para;</a></h3>
 <p><em>Appears on <a href="#spec.userConfig"><code>spec.userConfig</code></a>.</em></p>
-<p>Configure external secret providers in order to reference external secrets in connector configuration. Currently Hashicorp Vault (provider: vault, auth_method: token) and AWS Secrets Manager (provider: aws, auth_method: credentials) are supported. Secrets can be referenced in connector config with ${<provider_name>:<secret_path>:<key_name>}.</p>
+<p>SecretProvider.</p>
 <p><strong>Required</strong></p>
 <ul>
 <li><a href="#spec.userConfig.kafka_connect_secret_providers.name-property" name="spec.userConfig.kafka_connect_secret_providers.name-property"><code>name</code></a> (string). Name of the secret provider. Used to reference secrets in connector config.</li>

api-reference/kafkaconnect.html

@@ -2149,7 +2149,7 @@ <h2 id="spec.userConfig">userConfig<a class="headerlink" href="#spec.userConfig"
 </ul>
 <h3 id="spec.userConfig.ip_filter">ip_filter<a class="headerlink" href="#spec.userConfig.ip_filter" title="Permanent link">&para;</a></h3>
 <p><em>Appears on <a href="#spec.userConfig"><code>spec.userConfig</code></a>.</em></p>
-<p>Allow incoming connections from CIDR address block, e.g. <code>10.20.0.0/16</code>.</p>
+<p>CIDR address block, either as a string, or in a dict with an optional description field.</p>
 <p><strong>Required</strong></p>
 <ul>
 <li><a href="#spec.userConfig.ip_filter.network-property" name="spec.userConfig.ip_filter.network-property"><code>network</code></a> (string, MaxLength: 43). CIDR address block.</li>
@@ -2207,7 +2207,7 @@ <h3 id="spec.userConfig.public_access">public_access<a class="headerlink" href="
 </ul>
 <h3 id="spec.userConfig.secret_providers">secret_providers<a class="headerlink" href="#spec.userConfig.secret_providers" title="Permanent link">&para;</a></h3>
 <p><em>Appears on <a href="#spec.userConfig"><code>spec.userConfig</code></a>.</em></p>
-<p>Configure external secret providers in order to reference external secrets in connector configuration. Currently Hashicorp Vault (provider: vault, auth_method: token) and AWS Secrets Manager (provider: aws, auth_method: credentials) are supported. Secrets can be referenced in connector config with ${<provider_name>:<secret_path>:<key_name>}.</p>
+<p>SecretProvider.</p>
 <p><strong>Required</strong></p>
 <ul>
 <li><a href="#spec.userConfig.secret_providers.name-property" name="spec.userConfig.secret_providers.name-property"><code>name</code></a> (string). Name of the secret provider. Used to reference secrets in connector config.</li>

api-reference/mysql.html

@@ -2184,7 +2184,7 @@ <h2 id="spec.userConfig">userConfig<a class="headerlink" href="#spec.userConfig"
 </ul>
 <h3 id="spec.userConfig.ip_filter">ip_filter<a class="headerlink" href="#spec.userConfig.ip_filter" title="Permanent link">&para;</a></h3>
 <p><em>Appears on <a href="#spec.userConfig"><code>spec.userConfig</code></a>.</em></p>
-<p>Allow incoming connections from CIDR address block, e.g. <code>10.20.0.0/16</code>.</p>
+<p>CIDR address block, either as a string, or in a dict with an optional description field.</p>
 <p><strong>Required</strong></p>
 <ul>
 <li><a href="#spec.userConfig.ip_filter.network-property" name="spec.userConfig.ip_filter.network-property"><code>network</code></a> (string, MaxLength: 43). CIDR address block.</li>