Skip to content

Commit

Permalink
add: anchors
Browse files Browse the repository at this point in the history
  • Loading branch information
@ArthurFlag
ArthurFlag committed Oct 15, 2024
1 parent 6ce10c3 commit c1000c2
Show file tree
Hide file tree
Showing 30 changed files with 7,048 additions and 2,489 deletions.
4 changes: 4 additions & 0 deletions docs/products/mysql/reference/advanced-params.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,12 @@ title: Advanced parameters for Aiven for MySQL
sidebar_label: Advanced parameters
---

<div id="scrollPadding">

See the configuration options available for Aiven for MySQL:

import Reference from '@site/static/includes/config-mysql.md';

<Reference />

</div>
35 changes: 24 additions & 11 deletions scripts/service_type_parser.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,30 @@ handlebars.registerHelper('parameterDetailsHelper', function (options) {
var minimum = options.hash.minimum;
var maximum = options.hash.maximum;
var def = options.hash.def;
var fullname = parent + '.' + name;
var fullnameid = fullname.replace('.', '_');

var html = '<div class="param">';
var html = '<div className="param">';
if (parent) {
html += '<p class="name"><strong>' + parent + '.' + name + '</strong></p>';
html +=
'<p className="name" id="' +
fullnameid +
'"><strong>' +
fullname +
'</strong></p>';
} else {
html += '<p class="name"><strong>' + name + '</strong></p>';
html +=
'<p className="name" id="' + name + '"><strong>' + name + '</strong></p>';
}
html += '<p><code className="type">' + type + '</code></p>';
if (parent) {
html += '<a href="#' + fullnameid + '">#</a>';
} else {
html += '<a href="#' + name + '">#</a>';
}
html += '<p><code class="type">' + type + '</code></p>';
html += '</div>';
if (minimum || maximum || def) {
html += '<div class="constraints"><ul>';
html += '<div className="constraints"><ul>';
if (minimum) {
html += '<li>min: <code>' + minimum + '</code></li>';
}
Expand Down Expand Up @@ -94,7 +107,7 @@ async function fetchData(serviceName, outputFileName, filepath) {

const templateSource = `
<!-- vale off -->
<table class="service-param">
<table className="service-param">
<thead>
<tr><th>Parameter</th></tr>
</thead>
Expand All @@ -103,16 +116,16 @@ async function fetchData(serviceName, outputFileName, filepath) {
<tr>
<td>
{{parameterDetailsHelper name=@key type=type minimum=minimum maximum=maximum def=default}}
{{#if title~}}<p class="title">{{title}}</p>{{~/if}}
{{#if description~}}<div class="description"><p>{{description}}</p></div>{{~/if}}
<table class="service-param-children">
{{#if title~}}<p className="title">{{title}}</p>{{~/if}}
{{#if description~}}<div className="description"><p>{{description}}</p></div>{{~/if}}
<table className="service-param-children">
<tbody>
{{#each properties}}
<tr>
<td>
{{parameterDetailsHelper name=@key parent=@../key type=type minimum=minimum maximum=maximum def=default}}
{{#if title~}}<p class="title">{{title}}</p>{{~/if}}
{{#if description~}}<div class="description"><p>{{description}}</p></div>{{~/if}}
{{#if title~}}<p className="title">{{title}}</p>{{~/if}}
{{#if description~}}<div className="description"><p>{{description}}</p></div>{{~/if}}
</td>
</tr>
{{/each}}
Expand Down
10 changes: 10 additions & 0 deletions src/css/custom.css
View file
Original file line number Diff line number Diff line change
Expand Up @@ -229,10 +229,20 @@ ul+div {
margin-right: 0.5em;
}

.service-param .name {
scroll-margin-top: 70px;
}

.service-param .param {
display: flex;
}

.service-param .param a {
color: var(--ifm-link-color);
font-weight: bold;
margin-left: 0.5em;
}

.service-param .constraints ul {
list-style: none;
font-size: 90%;
Expand Down
556 changes: 278 additions & 278 deletions static/includes/config-alloydbomni.md
View file

Large diffs are not rendered by default.

228 changes: 114 additions & 114 deletions static/includes/config-caching.md
View file

Large diffs are not rendered by default.

134 changes: 67 additions & 67 deletions static/includes/config-cassandra.md
View file

Large diffs are not rendered by default.

261 changes: 261 additions & 0 deletions static/includes/config-cassandra.md.orig
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,261 @@

<!-- vale off -->
<table className="service-param">
<thead>
<tr><th>Parameter</th></tr>
</thead>
<tbody> <tr>
<td>
<<<<<<< HEAD
<div class="param"><p class="name"><strong>additional_backup_regions</strong></p><p><code class="type">array</code></p></div>
<p class="title">Additional Cloud Regions for Backup Replication</p>

<table class="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div class="param"><p class="name"><strong>ip_filter</strong></p><p><code class="type">array</code></p></div><div class="constraints"><ul><li>default: <code>0.0.0.0/0</code></li></ul></div>
<p class="title">IP filter</p>
<div class="description"><p>Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'</p></div>
<table class="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div class="param"><p class="name"><strong>service_log</strong></p><p><code class="type">boolean,null</code></p></div>
<p class="title">Service logging</p>
<div class="description"><p>Store logs for the service so that they are available in the HTTP API and console.</p></div>
<table class="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div class="param"><p class="name"><strong>static_ips</strong></p><p><code class="type">boolean</code></p></div>
<p class="title">Static IP addresses</p>
<div class="description"><p>Use static public IP addresses</p></div>
<table class="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div class="param"><p class="name"><strong>cassandra</strong></p><p><code class="type">object</code></p></div>
<p class="title">cassandra configuration values</p>
=======
<div className="param"><p className="name" id="additional_backup_regions"><strong>additional_backup_regions</strong></p><p><code className="type">array</code></p><a href="#additional_backup_regions">#</a></div>
<p className="title">Additional Cloud Regions for Backup Replication</p>
>>>>>>> cd68db9 (add: anchors)

<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="ip_filter"><strong>ip_filter</strong></p><p><code className="type">array</code></p><a href="#ip_filter">#</a></div><div className="constraints"><ul><li>default: <code>0.0.0.0/0</code></li></ul></div>
<p className="title">IP filter</p>
<div className="description"><p>Allow incoming connections from CIDR address block, e.g. '10.20.0.0/16'</p></div>
<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="service_log"><strong>service_log</strong></p><p><code className="type">boolean,null</code></p><a href="#service_log">#</a></div>
<p className="title">Service logging</p>
<div className="description"><p>Store logs for the service so that they are available in the HTTP API and console.</p></div>
<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="static_ips"><strong>static_ips</strong></p><p><code className="type">boolean</code></p><a href="#static_ips">#</a></div>
<p className="title">Static IP addresses</p>
<div className="description"><p>Use static public IP addresses</p></div>
<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="cassandra"><strong>cassandra</strong></p><p><code className="type">object</code></p><a href="#cassandra">#</a></div>
<p className="title">cassandra configuration values</p>

<table className="service-param-children">
<tbody>
<tr>
<td>
<div className="param"><p className="name" id="cassandra_batch_size_warn_threshold_in_kb"><strong>cassandra.batch_size_warn_threshold_in_kb</strong></p><p><code className="type">integer</code></p><a href="#cassandra_batch_size_warn_threshold_in_kb">#</a></div><div className="constraints"><ul><li>min: <code>1</code></li><li>max: <code>1000000</code></li></ul></div>
<p className="title">batch_size_warn_threshold_in_kb</p>
<div className="description"><p>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.</p></div>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="cassandra_batch_size_fail_threshold_in_kb"><strong>cassandra.batch_size_fail_threshold_in_kb</strong></p><p><code className="type">integer</code></p><a href="#cassandra_batch_size_fail_threshold_in_kb">#</a></div><div className="constraints"><ul><li>min: <code>1</code></li><li>max: <code>1000000</code></li></ul></div>
<p className="title">batch_size_fail_threshold_in_kb</p>
<div className="description"><p>Fail any multiple-partition batch exceeding this value. 50kb (10x warn threshold) by default.</p></div>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="cassandra_datacenter"><strong>cassandra.datacenter</strong></p><p><code className="type">string</code></p><a href="#cassandra_datacenter">#</a></div>
<p className="title">Cassandra datacenter name</p>
<div className="description"><p>Name of the datacenter to which nodes of this service belong. Can be set only when creating the service.</p></div>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="cassandra_write_request_timeout_in_ms"><strong>cassandra.write_request_timeout_in_ms</strong></p><p><code className="type">integer</code></p><a href="#cassandra_write_request_timeout_in_ms">#</a></div><div className="constraints"><ul><li>min: <code>1000</code></li><li>max: <code>10000</code></li></ul></div>
<p className="title">write_request_timeout_in_ms</p>
<div className="description"><p>How long the coordinator waits for write requests to complete with at least one node in the local datacenter. 2 seconds by default.</p></div>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="cassandra_read_request_timeout_in_ms"><strong>cassandra.read_request_timeout_in_ms</strong></p><p><code className="type">integer</code></p><a href="#cassandra_read_request_timeout_in_ms">#</a></div><div className="constraints"><ul><li>min: <code>1000</code></li><li>max: <code>10000</code></li></ul></div>
<p className="title">read_request_timeout_in_ms</p>
<div className="description"><p>How long the coordinator waits for read operations to complete before timing it out. 5 seconds by default.</p></div>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="migrate_sstableloader"><strong>migrate_sstableloader</strong></p><p><code className="type">boolean</code></p><a href="#migrate_sstableloader">#</a></div>
<p className="title">Migration mode for the sstableloader utility</p>
<div className="description"><p>Sets the service into migration mode enabling the sstableloader utility to be used to upload Cassandra data files. Available only on service create.</p></div>
<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="service_to_join_with"><strong>service_to_join_with</strong></p><p><code className="type">string</code></p><a href="#service_to_join_with">#</a></div>
<p className="title">Name of the service to form a bigger cluster with</p>
<div className="description"><p>When bootstrapping, instead of creating a new Cassandra cluster try to join an existing one from another service. Can only be set on service creation.</p></div>
<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="cassandra_version"><strong>cassandra_version</strong></p><p><code className="type">string,null</code></p><a href="#cassandra_version">#</a></div>
<p className="title">Cassandra version</p>

<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="private_access"><strong>private_access</strong></p><p><code className="type">object</code></p><a href="#private_access">#</a></div>
<p className="title">Allow access to selected service ports from private networks</p>

<table className="service-param-children">
<tbody>
<tr>
<td>
<div className="param"><p className="name" id="private_access_prometheus"><strong>private_access.prometheus</strong></p><p><code className="type">boolean</code></p><a href="#private_access_prometheus">#</a></div>
<p className="title">Allow clients to connect to prometheus with a DNS name that always resolves to the service's private IP addresses. Only available in certain network locations</p>

</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="public_access"><strong>public_access</strong></p><p><code className="type">object</code></p><a href="#public_access">#</a></div>
<p className="title">Allow access to selected service ports from the public Internet</p>

<table className="service-param-children">
<tbody>
<tr>
<td>
<div className="param"><p className="name" id="public_access_prometheus"><strong>public_access.prometheus</strong></p><p><code className="type">boolean</code></p><a href="#public_access_prometheus">#</a></div>
<p className="title">Allow clients to connect to prometheus from the public internet for service nodes that are in a project VPC or another type of private network</p>

</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="service_to_fork_from"><strong>service_to_fork_from</strong></p><p><code className="type">string,null</code></p><a href="#service_to_fork_from">#</a></div>
<p className="title">Name of another service to fork from. This has effect only when a new service is being created.</p>

<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="project_to_fork_from"><strong>project_to_fork_from</strong></p><p><code className="type">string,null</code></p><a href="#project_to_fork_from">#</a></div>
<p className="title">Name of another project to fork a service from. This has effect only when a new service is being created.</p>

<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="backup_hour"><strong>backup_hour</strong></p><p><code className="type">integer,null</code></p><a href="#backup_hour">#</a></div><div className="constraints"><ul><li>max: <code>23</code></li></ul></div>
<p className="title">The hour of day (in UTC) when backup for the service is started. New backup is only started if previous backup has already completed.</p>

<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
<tr>
<td>
<div className="param"><p className="name" id="backup_minute"><strong>backup_minute</strong></p><p><code className="type">integer,null</code></p><a href="#backup_minute">#</a></div><div className="constraints"><ul><li>max: <code>59</code></li></ul></div>
<p className="title">The minute of an hour when backup for the service is started. New backup is only started if previous backup has already completed.</p>

<table className="service-param-children">
<tbody>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>

Loading

0 comments on commit c1000c2

Please sign in to comment.