Skip to content

Commit

Permalink
PD-5215: Infrastructure for reference MongoDB Atlas OIDC parameters, …
Browse files Browse the repository at this point in the history
…misc
  • Loading branch information
adrian-velonis1 committed Dec 13, 2024
1 parent 2c1bc44 commit d43cddc
Show file tree
Hide file tree
Showing 21 changed files with 345 additions and 45 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,5 @@
<body>
<p>Initial billing mode for <MadCap:variable name="General.Liquibase" />&#160;<a href="../../../../../../concepts/tracking-tables/tracking-tables.htm">tracking tables</a> (<a href="../../../../../../concepts/tracking-tables/databasechangelog-table.html">DBCL</a> and <a href="../../../../../../concepts/tracking-tables/databasechangeloglock-table.html">DBCLL</a><MadCap:conditionalText MadCap:conditions="exclude.future-dynamodb">, and <a href="../../../../../../concepts/tracking-tables/databasechangeloghistory-table.htm">DBCLH</a></MadCap:conditionalText>). This controls how you pay for database <a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html">read/write operations and capacity</a>. Valid values: <code class="language-text">PROVISIONED</code> and <code class="language-text">PAY_PER_REQUEST</code>. <b>Default: <code class="language-text">PAY_PER_REQUEST</code></b>. See also: <a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_BillingModeSummary.html">BillingModeSummary</a>.</p>
<MadCap:snippetBlock src="../../../../note/parameter-amazon-dynamodb-tracking-tables-modify-billing-mode.flsnp" />
<p> </p>
</body>
</html>
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,5 @@
<body>
<p>Specifies how many <code MadCap:conditions="database-amazon-dynamodb-parameters.read"><a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Capacity.html">readCapacityUnits</a></code><code MadCap:conditions="database-amazon-dynamodb-parameters.write"><a href="https://docs.aws.amazon.com/amazondynamodb/latest/APIReference/API_Capacity.html">writeCapacityUnits</a></code> to initially use for the <code class="language-text">PROVISIONED</code> billing mode for <MadCap:variable name="General.Liquibase" />&#160;<a href="../../../../../../concepts/tracking-tables/tracking-tables.htm">tracking tables</a> (<a href="../../../../../../concepts/tracking-tables/databasechangelog-table.html">DBCL</a> and <a href="../../../../../../concepts/tracking-tables/databasechangeloglock-table.html">DBCLL<MadCap:conditionalText MadCap:conditions="exclude.future-dynamodb">, and <a href="../../../../../../concepts/tracking-tables/databasechangeloghistory-table.htm">DBCLH</a></MadCap:conditionalText></a>). Ignored for the <code class="language-text">PAY_PER_REQUEST</code> billing mode. <b>Default: <code class="language-text">10</code></b>. See also:&#160;<a href="https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/HowItWorks.ReadWriteCapacityMode.html">Read/write capacity mode</a>.</p>
<MadCap:snippetBlock src="../../../../note/parameter-amazon-dynamodb-tracking-tables-modify-provisioned-throughput.flsnp" />
<p>&#160;</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd">
<head>
</head>
<body>
<p>Enabling this property will validate History Change Log and Log Lock Collections on Startup and adjust if are not up to date with current release. Worth keeping it disabled and re-enable when upgraded to a new <MadCap:variable name="General.Liquibase" /> version. <b>Default: <code>true</code></b>.</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" MadCap:searchable="False">
<head>
</head>
<body>
<p>Description. <b>Default: <code class="language-text">VALUE</code></b>.</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" MadCap:searchable="False">
<head>
</head>
<body>
<p>Description. <b>Default: <code class="language-text">VALUE</code></b>.</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" MadCap:searchable="False">
<head>
</head>
<body>
<p>Description. <b>Default: <code class="language-text">VALUE</code></b>.</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" MadCap:searchable="False">
<head>
</head>
<body>
<p>Description. <b>Default: <code class="language-text">VALUE</code></b>.</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd">
<head>
</head>
<body>
<p>Setting this property to <code>false</code> will add <code>retryWrites=false</code> to connection URL. This will permit usage on Mongo Versions not supporting <code>retryWrites</code>, like <a href="../../../../../../start/tutorials/mongodb-pro/amazon-documentdb.htm">Amazon DocumentDB</a>. <b>Default: <code>true</code></b>.</p>
</body>
</html>
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?xml version="1.0" encoding="utf-8"?>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd">
<head>
</head>
<body>
<p>Disabling this property will let create the Tracking Collections without validators. This will permit usage on Mongo Versions not supporting Validators. <b>Default:&#160;<code>true</code></b>.</p>
</body>
</html>
103 changes: 103 additions & 0 deletions Content/Z_Resources/Snippets/text/parameter-mongodb-param-list.flsnp
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
<?xml version="1.0" encoding="utf-8"?>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" MadCap:searchable="False">
<body>
<table style="width: 100%;">
<col />
<col />
<col />
<thead>
<tr>
<th>Name (<code>--cli</code>, <code>{flow-file}</code>, <code>propertiesFile</code>, <code>ENV_VAR</code>)</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><pre xml:space="preserve"><code class="language-text">--mongodb-adjust-tracking-tables-on-startup
globalArgs: {adjust-tracking-tables-on-startup: "val"}
liquibase.mongodb.adjustTrackingTablesOnStartup
LIQUIBASE_MONGODB_ADJUST_TRACKING_TABLES_ON_STARTUP</code></pre>
<p>Read more: <code>--<MadCap:xref href="../../../parameters/mongodb/mongodb-adjust-tracking-tables-on-startup.htm">mongodb-adjust-tracking-tables-on-startup</MadCap:xref></code></p>
</td>
<td>Boolean</td>
<td>
<MadCap:snippetBlock src="../def/attributes/cli/mongodb/cli-global-mongodb-adjust-tracking-tables-on-startup.flsnp" />
</td>
</tr>
<tr>
<td><pre xml:space="preserve"><code class="language-text">--mongodb-oidc-authentication-mechanism
globalArgs: {mongodb-oidc-authentication-mechanism: "val"}
liquibase.mongodb.oidc.authenticationMechanism
LIQUIBASE_MONGODB_OIDC_AUTHENTICATION_MECHANISM</code></pre>
<p>Read more: <code>--<MadCap:xref href="../../../parameters/mongodb/mongodb-oidc-authentication-mechanism.htm">mongodb-oidc-authentication-mechanism</MadCap:xref></code></p>
</td>
<td>String</td>
<td>
<MadCap:snippetBlock src="../def/attributes/cli/mongodb/cli-global-mongodb-oidc-authentication-mechanism.flsnp" />
</td>
</tr>
<tr>
<td><pre xml:space="preserve"><code class="language-text">--mongodb-oidc-environment
globalArgs: {mongodb-oidc-environment: "val"}
liquibase.mongodb.oidc.environment
LIQUIBASE_MONGODB_OIDC_ENVIRONMENT</code></pre>
<p>Read more: <code>--<MadCap:xref href="../../../parameters/mongodb/mongodb-oidc-environment.htm">mongodb-oidc-environment</MadCap:xref></code></p>
</td>
<td>String</td>
<td>
<MadCap:snippetBlock src="../def/attributes/cli/mongodb/cli-global-mongodb-oidc-environment.flsnp" />
</td>
</tr>
<tr>
<td><pre xml:space="preserve"><code class="language-text">--mongodb-oidc-oidc-application-id-uri
globalArgs: {mongodb-oidc-oidc-application-id-uri: "val"}
liquibase.mongodb.oidc.oidcApplicationIDURI
LIQUIBASE_MONGODB_OIDC_OIDC_APPLICATION_ID_URI</code></pre>
<p>Read more: <code>--<MadCap:xref href="../../../parameters/mongodb/mongodb-oidc-oidc-application-id-uri.htm">mongodb-oidc-oidc-application-id-uri</MadCap:xref></code></p>
</td>
<td>String</td>
<td>
<MadCap:snippetBlock src="../def/attributes/cli/mongodb/cli-global-mongodb-oidc-oidc-application-uri.flsnp" />
</td>
</tr>
<tr>
<td><pre xml:space="preserve"><code class="language-text">--mongodb-oidc-oidc-client-id
globalArgs: {mongodb-oidc-oidc-client-id: "val"}
liquibase.mongodb.oidc.oidcClientID
LIQUIBASE_MONGODB_OIDC_OIDC_CLIENT_ID</code></pre>
<p>Read more: <code>--<MadCap:xref href="../../../parameters/mongodb/mongodb-oidc-oidc-client-id.htm">mongodb-oidc-oidc-client-id</MadCap:xref></code></p>
</td>
<td>String</td>
<td>
<MadCap:snippetBlock src="../def/attributes/cli/mongodb/cli-global-mongodb-oidc-oidc-client-id.flsnp" />
</td>
</tr>
<tr>
<td><pre xml:space="preserve"><code class="language-text">--mongodb-retry-writes
globalArgs: {retry-writes: "val"}
liquibase.mongodb.retryWrites
LIQUIBASE_MONGODB_RETRY_WRITES</code></pre>
<p>Read more: <code>--<MadCap:xref href="../../../parameters/mongodb/mongodb-retry-writes.htm">mongodb-retry-writes</MadCap:xref></code></p>
</td>
<td>Boolean</td>
<td>
<MadCap:snippetBlock src="../def/attributes/cli/mongodb/cli-global-mongodb-retry-writes.flsnp" />
</td>
</tr>
<tr>
<td><pre xml:space="preserve"><code class="language-text">--mongodb-supports-validator
globalArgs: {supports-validator: "val"}
liquibase.mongodb.supportsValidator
LIQUIBASE_MONGODB_SUPPORTS_VALIDATOR</code></pre>
<p>Read more: <code>--<MadCap:xref href="../../../parameters/mongodb/mongodb-supports-validator.htm">mongodb-supports-validator</MadCap:xref></code></p>
</td>
<td>Boolean</td>
<td>
<MadCap:snippetBlock src="../def/attributes/cli/mongodb/cli-global-mongodb-supports-validator.flsnp" />
</td>
</tr>
</tbody>
</table>
</body>
</html>
6 changes: 6 additions & 0 deletions Content/change-types/mongodb/home.htm
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,11 @@ <h3><MadCap:variable name="General.Liquibase" /> MongoDB&#160;Open Source Extens
<li><code><MadCap:xref href="run-command.htm">runCommand</MadCap:xref></code>
</li>
</ul>
<h2 id="related-links">Related links</h2>
<ul>
<li>
<MadCap:xref href="../../parameters/mongodb/home.htm">[%=General.Liquibase%] Parameters for MongoDB Pro</MadCap:xref>
</li>
</ul>
</body>
</html>
46 changes: 3 additions & 43 deletions Content/parameters/home.htm
Original file line number Diff line number Diff line change
Expand Up @@ -1123,51 +1123,11 @@ <h3><MadCap:variable name="General.StructuredLogging"></MadCap:variable>
</table>
<h3>Extensions</h3>
<h4>Amazon DynamoDB</h4>
<p>For more information, see <MadCap:xref href="amazon-dynamodb/home.htm">[%=General.Liquibase%] Parameters for Amazon DynamoDB Pro</MadCap:xref> and <MadCap:xref href="../start/tutorials/amazon-dynamodb-pro/amazon-dynamodb.htm">Using [%=General.Liquibase%] with Amazon DynamoDB Pro</MadCap:xref>.</p>
<p>For more information, see <MadCap:xref href="amazon-dynamodb/home.htm">[%=General.Liquibase%] Parameters for Amazon DynamoDB Pro</MadCap:xref> and <MadCap:xref href="../start/tutorials/amazon-dynamodb-pro/home.htm">[%=General.Liquibase%] Amazon DynamoDB Pro Extension Overview</MadCap:xref>.</p>
<MadCap:snippetBlock src="../Z_Resources/Snippets/text/parameter-amazon-dynamodb-param-list.flsnp" />
<h4>MongoDB Pro</h4>
<p>For more information, see <MadCap:xref href="../start/tutorials/mongodb-pro/home.htm">Using [%=General.Liquibase%] MongoDB Pro with MongoDB Platforms</MadCap:xref>.</p>
<table>
<col />
<col />
<col />
<thead>
<tr>
<th>Syntax (<code>--cli</code>, <code>{flow-file}</code>, <code>propertiesFile</code>, <code>ENV_VAR</code>)</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><pre xml:space="preserve"><code class="language-text">--adjust-tracking-tables-on-startup
globalArgs: {adjust-tracking-tables-on-startup: "val"}
liquibase.mongodb.adjustTrackingTablesOnStartup
LIQUIBASE_MONGODB_ADJUST_TRACKING_TABLES_ON_STARTUP</code></pre>
</td>
<td>Boolean</td>
<td>Enabling this property will validate History Change Log and Log Lock Collections on Startup and adjust if are not up to date with current release. Worth keeping it disabled and re-enable when upgraded to a new <MadCap:variable name="General.Liquibase" /> version. <b>Default:&#160;<code>true</code></b>.</td>
</tr>
<tr>
<td><pre xml:space="preserve"><code class="language-text">--retry-writes
globalArgs: {retry-writes: "val"}
liquibase.mongodb.retryWrites
LIQUIBASE_MONGODB_RETRY_WRITES</code></pre>
</td>
<td>Boolean</td>
<td>Setting this property to <code>false</code> will add <code>retryWrites=false</code> to connection URL. This will permit usage on Mongo Versions not supporting <code>retryWrites</code>, like <a href="../start/tutorials/mongodb-pro/amazon-documentdb.htm">Amazon DocumentDB</a>. <b>Default:&#160;<code>true</code></b>.</td>
</tr>
<tr>
<td><pre xml:space="preserve"><code class="language-text">--supports-validator
globalArgs: {supports-validator: "val"}
liquibase.mongodb.supportsValidator
LIQUIBASE_MONGODB_SUPPORTS_VALIDATOR</code></pre>
</td>
<td>Boolean</td>
<td>Disabling this property will let create the Tracking Collections without validators. This will permit usage on Mongo Versions not supporting Validators. <b>Default:&#160;<code>true</code></b>.</td>
</tr>
</tbody>
</table>
<p>For more information, see <MadCap:xref href="mongodb/home.htm">[%=General.Liquibase%] Parameters for MongoDB Pro</MadCap:xref> and <MadCap:xref href="../start/tutorials/mongodb-pro/home.htm">Using [%=General.Liquibase%] MongoDB Pro with MongoDB Platforms</MadCap:xref>.</p>
<MadCap:snippetBlock src="../Z_Resources/Snippets/text/parameter-mongodb-param-list.flsnp" />
<h3>Configuration</h3>
<p class="note" MadCap:autonum="&lt;b&gt;Note: &lt;/b&gt;">Before <MadCap:variable name="General.Liquibase" /> 4.25.0, the following configuration properties can only be set as operating system environment variables (such as <code>LIQUIBASE_HOME</code>). In <MadCap:variable name="General.Liquibase" /> 4.25.0+, you can set these with the <MadCap:xref href="../concepts/connections/java-opts-environment-variable.htm">JAVA_OPTS Environment Variable</MadCap:xref> (such as <code>liquibase.home</code>) like other <MadCap:variable name="General.Liquibase" /> parameters on this page.</p>
<table>
Expand Down
26 changes: 26 additions & 0 deletions Content/parameters/mongodb/home.htm
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
<?xml version="1.0" encoding="utf-8"?>
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd" MadCap:searchable="False">
<head><title><MadCap:variable name="Heading.Level1" /></title>
<link rel="canonical" href="https://docs.liquibase.com/parameters/amazon-dynamodb/home.html" />
<meta name="description" content="This page lists parameters you can use with the Liquibase extension for Amazon DynamoDB." />
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<MadCap:snippetBlock src="../../Z_Resources/Snippets/images/icon-pro-top.flsnp" />
<h1><MadCap:variable name="General.Liquibase" /> Parameters for MongoDB Pro</h1>
<p>You can control the way <MadCap:variable name="General.Liquibase" /> behaves when running commands on your MongoDB&#160;database by setting <MadCap:variable name="General.Liquibase" /> parameters. For example, you can use them to configure OIDC&#160;authentication on MongoDB&#160;Atlas.</p>
<p>For a list of general <MadCap:variable name="General.Liquibase" /> parameters, see <MadCap:xref href="../home.htm">[%=General.Liquibase%] Parameters</MadCap:xref>.</p>
<p>For more information about MongoDB, see <MadCap:xref href="../../start/tutorials/mongodb-pro/home.htm">Using [%=General.Liquibase%] MongoDB Pro with MongoDB Platforms</MadCap:xref>.</p>
<h2>List of parameters</h2>
<MadCap:snippetBlock src="../../Z_Resources/Snippets/note/parameter-syntax.flsnp" />
<MadCap:snippetBlock src="../../Z_Resources/Snippets/note/command-parameter-kebab.flsnp">
</MadCap:snippetBlock>
<MadCap:snippetBlock src="../../Z_Resources/Snippets/text/parameter-mongodb-param-list.flsnp" />
<h2 id="related-links">Related links</h2>
<ul>
<li>
<MadCap:xref href="../../change-types/mongodb/home.htm">[%=General.Liquibase%]&#160;[%=General.changetypes%]s for MongoDB</MadCap:xref>
</li>
</ul>
</body>
</html>
Loading

0 comments on commit d43cddc

Please sign in to comment.