Skip to content

Commit

Permalink
PD-3604
Browse files Browse the repository at this point in the history
  • Loading branch information
@adrian-velonis1
adrian-velonis1 committed Aug 9, 2023
1 parent 69515c3 commit f4011fc
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 8 deletions.
16 changes: 11 additions & 5 deletions Content/commands/quality-checks/workflows/use-checks-settings-config-file.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@
<html xmlns:MadCap="http://www.madcapsoftware.com/Schemas/MadCap.xsd">
<head><title><MadCap:variable name="Heading.Level1" /></title>
<link rel="canonical" href="https://docs.liquibase.com/commands/quality-checks/workflows/using-the-checks-settings-configuration-file.html" />
<meta name="description" content="The checks settings file includes your configuration of checks, which might be tied to a specific project or shared across a team or organization." />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description" content="The checks settings file includes your configuration of checks, which might be tied to a specific project or shared across a team or organization." />
<meta name="viewport" content="width=device-width, initial-scale=1" />
</head>
<body>
<h1>Use the Checks Settings Configuration File</h1>
<MadCap:snippetText src="../../../Z_Resources/Snippets/images/icon-pro-top.flsnp" />
<p>Another part of the <MadCap:variable name="General.Liquibase" /> quality checks configuration is the checks settings file named as <code>liquibase.checks-settings.conf</code> by default.</p>
<p>The checks settings file includes your configuration of checks, which you can use for a specific project or share across a team or organization. You may have multiple checks settings configuration files and store them in source code control or artifact repository for versioning, consistent use, and automation.</p>
<p>In <MadCap:variable name="General.Liquibase" /> 4.5, the checks settings file is encoded, while <MadCap:variable name="General.Liquibase" /> 4.6.0 and later versions provide unencoded checks settings files. An unencoded file is easier to inspect and resolve merge conflicts when using SCM.</p>
<h2>Creating and modifying the checks settings file</h2>
<h2>Creating the checks settings file</h2>
<p>When you start using the quality checks functionality by running any checks command, <MadCap:variable name="General.Liquibase" /> identifies the need for a checks settings file:</p>
<ul>
<li>To create the default checks settings file named <code>liquibase.checks-settings.conf</code> in the <MadCap:variable name="General.Liquibase" /> working directory, enter <b>Y</b> at runtime.
Expand All @@ -27,11 +27,10 @@ <h2>Creating and modifying the checks settings file</h2>
</ul>
</li>
</ul>
<p class="warning" MadCap:autonum="&lt;b&gt;Warning: &lt;/b&gt;">Do not modify the checks settings file directly because it may cause unrecoverable and unsupported errors.</p>
<p class="warning" MadCap:autonum="&lt;b&gt;Warning: &lt;/b&gt;"><b>Do not manually modify the checks settings file</b> because it may cause unrecoverable and unsupported errors.</p>
<h3>Automatic update of checks settings file 4.5.0 with the use of <MadCap:variable name="General.Liquibase" /> 4.6.0 and later versions</h3>
<p>When you use an encoded checks settings file from <MadCap:variable name="General.Liquibase" /> 4.5.0 with <MadCap:variable name="General.Liquibase" /> 4.6.0 or later versions, <MadCap:variable name="General.Liquibase" /> will automatically back up your checks settings file as <code>liquibase.checks-settings.conf.v4.5</code> and update it.</p>
<p>In most cases, you do not need to take any action. However, when you work in an environment in which a <MadCap:variable name="General.Liquibase" /> 4.5.0 user cannot upgrade to version 4.6.0 and must use the same shared checks settings file, the <MadCap:variable name="General.Liquibase" /> 4.5.0 user needs to specify the compliant checks settings file 4.5.0 by using <code>--checks-settings-file=&lt;mybackedupfile.conf.v4.5&gt;</code>.</p>
<p>The following examples use the default name of the checks settings file, but the same is true for any specified checks settings file:</p>
<ul>
<li>If you use <MadCap:variable name="General.Liquibase" /> 4.5.0, you will have the encoded <code>liquibase.checks-settings.conf</code> file and it will remain encoded so long as you use version 4.5.0.
</li>
Expand All @@ -40,6 +39,13 @@ <h3>Automatic update of checks settings file 4.5.0 with the use of <MadCap:varia
<li>If you have <MadCap:variable name="General.Liquibase" /> 4.6.0 or later versions and use an encoded checks settings file 4.5.0, it will be backed up and unencoded automatically.
</li>
</ul>
<h3>Check Settings File Format</h3>
<p>The <code>liquibase.checks-settings.conf</code> internal file format has changed over time to simplify the process of managing the file in source control.</p>
<ul>
<li>In <MadCap:variable name="General.Liquibase" /> 4.5.0, the file was encoded, which made it difficult to merge changes.</li>
<li>In<MadCap:variable name="General.Liquibase" /> 4.6.0 through <MadCap:variable name="General.Liquibase" /> 4.23.0,this was remedied by changing the file to an unencoded proprietary format.</li>
<li>In <MadCap:variable name="General.Liquibase" /> 4.23.1 and later, the file format was changed to YAML for better readability and easier management. <b>It is still recommended policy to use </b><MadCap:variable name="General.Liquibase" style="font-weight: bold;" /><b>commands to manage this file and never make manual edits.</b></li>
</ul>
<h2>Related links</h2>
<ul>
<li>
Expand Down
6 changes: 3 additions & 3 deletions Content/start/tutorials/mongodb-pro-aws-doc-config.htm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ <h1>MongoDB Pro and Amazon DocumentDB TLS/SSL&#160;Configuration</h1>
<li>Create Java Truststore. Items 1 and 2 in <a href="https://docs.aws.amazon.com/documentdb/latest/developerguide/connect_programmatically.html#connect_programmatically-tls_enabled">Connecting Programmatically to Amazon DocumentDB § Connecting with TLS Enabled</a> (for Java snippet)</li>
<li>Add Amazon DocumentDB credentials (<code>liquibase.command.username</code>, <code>liquibase.command.password</code>) to the <a href="../../concepts/connections/creating-config-properties.html"><code>liqubase.properties</code> file</a>, environment variables, or command line.</li>
<li>Specify the <code>supportsValidator</code> property:</li><pre><code class="language-text">liquibase.mongodb.supportsValidator: false</code></pre>
<li>Specify a connection string:</li><pre><code class="language-text">liquibase.command.url: mongodb://localhost:27017/lbcat?tls=true&amp;tlsAllowInvalidHostnames=true&amp;retryWrites=false&amp;tlsCAFile=PATH_TO_TRUSTSTORE/rds-combined-ca-bundle.pem</code></pre>
<p class="note" MadCap:autonum="&lt;b&gt;Note: &lt;/b&gt;">The <code>location localhost:27017</code> is used from the SSH tunnel (created on the first step) <br /><br />For connection from outside an Amazon VPC, it should contain attributes <code>tls=true&amp;tlsAllowInvalidHostnames=true&amp;retryWrites=false&amp;tlsCAFile=PATH_TO_TRUSTSTORE/rds-combined-ca-bundle.pem</code></p>
<li>Specify a connection string:</li><pre><code class="language-text">liquibase.command.url: mongodb://localhost:27017/lbcat?tls=true&amp;tlsAllowInvalidHostnames=true&amp;retryWrites=false&amp;tlsCAFile=PATH_TO_CAFILE/rds-combined-ca-bundle.pem</code></pre>
<p class="note" MadCap:autonum="&lt;b&gt;Note: &lt;/b&gt;">The <code>location localhost:27017</code> is used from the SSH tunnel (created on the first step) <br /><br />For connection from outside an Amazon VPC, it should contain attributes <code>tls=true&amp;tlsAllowInvalidHostnames=true&amp;retryWrites=false&amp;tlsCAFile=PATH_TO_CAFILE/rds-combined-ca-bundle.pem</code></p>
<li>Add information about Truststore (created on the second step) to environment variables before running <MadCap:variable name="General.Liquibase" /> commands:</li>
<p>On Linux:</p><pre><code class="language-text">export JAVA_OPTS="-Djavax.net.ssl.trustStore=PATH_TO_TRUSTSTORE/rds-truststore.jks -Djavax.net.ssl.trustStorePassword=PASSWORD"</code></pre>
<p>On Windows:</p><pre><code class="language-text">set JAVA_OPTS=-Djavax.net.ssl.trustStore="PATH_TO_KEYSTORE\\rds-truststore.jks" -Djavax.net.ssl.trustStorePassword=PASSWORD</code></pre>
<p>On Windows:</p><pre><code class="language-text">set JAVA_OPTS=-Djavax.net.ssl.trustStore="PATH_TO_TRUSTSTORE\\rds-truststore.jks" -Djavax.net.ssl.trustStorePassword=PASSWORD</code></pre>
</ol>
</body>
</html>

0 comments on commit f4011fc

Please sign in to comment.