Deployed 2f31c0e to main with MkDocs 1.6.1 and mike 2.1.3

Author: GitHub Action

main/apt.html

@@ -6,7 +6,7 @@
       <meta charset="utf-8">
       <meta name="viewport" content="width=device-width,initial-scale=1">
 
-        <meta name="description" content="The packages for pg_tde Beta are available in the testing repository for Percona Distribution for PostgreSQL 16.">
+        <meta name="description" content="The packages for the tech preview pg_tde are available in the experimental repository for Percona Distribution for PostgreSQL 17.">
 
 
         <meta name="author" content="Percona LLC">
@@ -962,7 +962,6 @@
 
 
 <h1 id="install-pg_tde-on-debian-or-ubuntu">Install <code>pg_tde</code> on Debian or Ubuntu<a class="headerlink" href="#install-pg_tde-on-debian-or-ubuntu" title="Permanent link">&para;</a></h1>
-<p>The packages for <code>pg_tde</code> Beta are available in the testing repository for Percona Distribution for PostgreSQL 16. </p>
 <p>The packages for the tech preview <code>pg_tde</code> are available in the experimental repository for Percona Distribution for PostgreSQL 17. </p>
 <p>Check the <a href="install.html#__tabbed_1_2">list of supported platforms</a>.</p>
 <p>This tutorial shows how to install <code>pg_tde</code> with <a href="https://docs.percona.com/postgresql/latest/index.html">Percona Distribution for PostgreSQL</a>.</p>
@@ -993,18 +992,14 @@ <h2 id="preconditions">Preconditions<a class="headerlink" href="#preconditions"
 </li>
 <li>
 <p>Enable the Percona Distribution for PostgreSQL repository</p>
-<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">pg_tde Beta</label><label for="__tabbed_1_2">pg_tde Tech preview</label></div>
-<div class="tabbed-content">
-<div class="tabbed-block">
-<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>percona-release<span class="w"> </span>enable-only<span class="w"> </span>ppg-16.4<span class="w"> </span>testing
+<p>Percona provides <a href="repo-overview.md">two repositories</a> for Percona Distribution for PostgreSQL. We recommend enabling the Major release repository to timely receive the latest updates. </p>
+<div class="highlight" data-prompt="$"><pre><span></span><code>$<span class="w"> </span>sudo<span class="w"> </span>percona-release<span class="w"> </span>setup<span class="w"> </span>ppg-17
 </code></pre></div>
-</div>
-<div class="tabbed-block">
-<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>percona-release<span class="w"> </span>enable-only<span class="w"> </span>ppg-17.0<span class="w"> </span>experimental
+</li>
+<li>
+<p>Enable the experimental Percona Distribution for PostgreSQL repository that contains the pg_tde package</p>
+<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>percona-release<span class="w"> </span><span class="nb">enable</span><span class="w"> </span>ppg-17.0<span class="w"> </span>experimental
 </code></pre></div>
-</div>
-</div>
-</div>
 </li>
 <li>
 <p>Update the local cache</p>
@@ -1013,29 +1008,11 @@ <h2 id="preconditions">Preconditions<a class="headerlink" href="#preconditions"
 </li>
 </ol>
 <h2 id="install-pg_tde">Install <code>pg_tde</code><a class="headerlink" href="#install-pg_tde" title="Permanent link">&para;</a></h2>
-<div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1">pg_tde Beta</label><label for="__tabbed_2_2">pg_tde Tech preview</label></div>
-<div class="tabbed-content">
-<div class="tabbed-block">
 <ol>
 <li>
 <p>Install Percona Distribution for PostgreSQL. </p>
 <p>Run the following command to install Percona Distribution for PostgreSQL and the required packages:</p>
-<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>percona-postgresql-16<span class="w"> </span>percona-postgresql-contrib<span class="w">     </span>percona-postgresql-server-dev-all
-</code></pre></div>
-</li>
-<li>
-<p>Install <code>pg_tde</code> packages</p>
-<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>percona-postgresql-16-pg-tde
-</code></pre></div>
-</li>
-</ol>
-</div>
-<div class="tabbed-block">
-<ol>
-<li>
-<p>Install Percona Distribution for PostgreSQL. </p>
-<p>Run the following command to install Percona Distribution for PostgreSQL and the required packages:</p>
-<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>percona-postgresql-17<span class="w"> </span>percona-postgresql-contrib<span class="w">     </span>percona-postgresql-server-dev-all
+<div class="highlight"><pre><span></span><code>sudo<span class="w"> </span>apt-get<span class="w"> </span>install<span class="w"> </span>-y<span class="w"> </span>percona-postgresql-17<span class="w"> </span>percona-postgresql-contrib<span class="w"> </span>percona-postgresql-server-dev-all
 </code></pre></div>
 </li>
 <li>
@@ -1044,9 +1021,6 @@ <h2 id="install-pg_tde">Install <code>pg_tde</code><a class="headerlink" href="#
 </code></pre></div>
 </li>
 </ol>
-</div>
-</div>
-</div>
 <h2 id="next-step">Next step<a class="headerlink" href="#next-step" title="Permanent link">&para;</a></h2>
 <p><a class="md-button" href="setup.html">Setup</a></p>
 <div data-banner="data-banner">
@@ -1082,7 +1056,7 @@ <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">October 8, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 8, 2024</span>
   </span>
 
 

main/install.html

@@ -988,6 +988,7 @@ <h2 id="procedure">Procedure<a class="headerlink" href="#procedure" title="Perma
 <li>Red Hat Enterprise Linux 9 and compatible derivatives</li>
 <li>Ubuntu 20.04 (Focal Fossa)</li>
 <li>Ubuntu 22.04 (Jammy Jellyfish)</li>
+<li>Ubuntu 24.04 (Noble Numbat)</li>
 <li>Debian 11 (Bullseye) </li>
 <li>Debian 12 (Bookworm)</li>
 </ul>
@@ -1076,7 +1077,7 @@ <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 7, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 8, 2024</span>
   </span>
 
 

main/search/search_index.json

@@ -1038,11 +1038,17 @@ <h2 id="key-provider-configuration">Key provider configuration<a class="headerli
 </div>
 </div>
 </div>
+<p><i warning><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2"/></svg></span> Warning:</i> Example for testing purposes only:</p>
+<div class="highlight"><pre><span></span><code><span class="k">SELECT</span><span class="w"> </span><span class="n">pg_tde_add_key_provider_file</span><span class="p">(</span><span class="s1">&#39;file-vault&#39;</span><span class="p">,</span><span class="s1">&#39;/tmp/pg_tde_test_local_keyring.per&#39;</span><span class="p">);</span>
+</code></pre></div>
 </li>
 <li>
 <p>Add a principal key</p>
 <div class="highlight"><pre><span></span><code><span class="k">SELECT</span><span class="w"> </span><span class="n">pg_tde_set_principal_key</span><span class="p">(</span><span class="s1">&#39;name-of-the-principal-key&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;provider-name&#39;</span><span class="p">);</span>
 </code></pre></div>
+<p><i warning><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2"/></svg></span> Warning:</i> Example for testing purposes only:</p>
+<div class="highlight"><pre><span></span><code><span class="k">SELECT</span><span class="w"> </span><span class="n">pg_tde_set_principal_key</span><span class="p">(</span><span class="s1">&#39;test-db-master-key&#39;</span><span class="p">,</span><span class="s1">&#39;file-vault&#39;</span><span class="p">);</span>
+</code></pre></div>
 </li>
 </ol>
 <p><i info><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2"/></svg></span> Info:</i> The key provider configuration is stored in the database catalog in an unencrypted table. See <a href="external-parameters.html">how to use external reference to parameters</a> to add an extra security layer to your setup.</p>
@@ -1070,32 +1076,29 @@ <h2 id="wal-encryption-configuration-tech-preview">WAL encryption configuration
 <li>
 <p>We highly recommend you to create your own keyring and rotate the principal key. This is because the default principal key is created from the local keyfile and is stored unencrypted. </p>
 <p>Set up the key provider for WAL encryption</p>
-</li>
-</ol>
-<p>=== &ldquo;With HashiCorp Vault&rdquo;</p>
-<div class="highlight"><pre><span></span><code>    ```sql
-    SELECT pg_tde_add_key_provider_vault_v2(&#39;PG_TDE_GLOBAL&#39;,&#39;provider-name&#39;,:&#39;secret_token&#39;,&#39;url&#39;,&#39;mount&#39;,&#39;ca_path&#39;);
-    ```
-
-    where:
-
-    * `PG_TDE_GLOBAL` is the constant that defines the WAL encryption key  
-    * `provider-name` is the name you define for the key provider
-    * `url` is the URL of the Vault server
-    * `mount` is the mount point where the keyring should store the keys
-    * `secret_token` is an access token with read and write access to the above mount point
-    * [optional] `ca_path` is the path of the CA file used for SSL verification
-
-
-=== &quot;With keyring file&quot;
-
-    This setup is intended for development and stores the keys unencrypted in the specified data file.
-
-    ```sql
-    SELECT pg_tde_add_key_provider_file(&#39;provider-name&#39;,&#39;/path/to/the/keyring/data.file&#39;);
-    ```
+<div class="tabbed-set tabbed-alternate" data-tabs="2:2"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1">With HashiCorp Vault</label><label for="__tabbed_2_2">With keyring file</label></div>
+<div class="tabbed-content">
+<div class="tabbed-block">
+<div class="highlight"><pre><span></span><code><span class="k">SELECT</span><span class="w"> </span><span class="n">pg_tde_add_key_provider_vault_v2</span><span class="p">(</span><span class="s1">&#39;PG_TDE_GLOBAL&#39;</span><span class="p">,</span><span class="s1">&#39;provider-name&#39;</span><span class="p">,:</span><span class="s1">&#39;secret_token&#39;</span><span class="p">,</span><span class="s1">&#39;url&#39;</span><span class="p">,</span><span class="s1">&#39;mount&#39;</span><span class="p">,</span><span class="s1">&#39;ca_path&#39;</span><span class="p">);</span>
 </code></pre></div>
-<ol>
+<p>where: </p>
+<ul>
+<li><code>PG_TDE_GLOBAL</code> is the constant that defines the WAL encryption key  </li>
+<li><code>provider-name</code> is the name you define for the key provider</li>
+<li><code>url</code> is the URL of the Vault server</li>
+<li><code>mount</code> is the mount point where the keyring should store the keys</li>
+<li><code>secret_token</code> is an access token with read and write access to the above mount point</li>
+<li>[optional] <code>ca_path</code> is the path of the CA file used for SSL verification</li>
+</ul>
+</div>
+<div class="tabbed-block">
+<p>This setup is intended for development and stores the keys unencrypted in the specified data file.    </p>
+<div class="highlight"><pre><span></span><code><span class="k">SELECT</span><span class="w"> </span><span class="n">pg_tde_add_key_provider_file</span><span class="p">(</span><span class="s1">&#39;provider-name&#39;</span><span class="p">,</span><span class="s1">&#39;/path/to/the/keyring/data.file&#39;</span><span class="p">);</span>
+</code></pre></div>
+</div>
+</div>
+</div>
+</li>
 <li>
 <p>Rotate the principal key. Don&rsquo;t forget to specify the <code>PG_TDE_GLOBAL</code> constant to rotate only the principal key for WAL.</p>
 <div class="highlight"><pre><span></span><code><span class="k">SELECT</span><span class="w"> </span><span class="n">pg_tde_rotate_principal_key</span><span class="p">(</span><span class="s1">&#39;PG_TDE_GLOBAL&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;new-principal-key&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;provider-name&#39;</span><span class="p">);</span>
@@ -1138,7 +1141,7 @@ <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 7, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 8, 2024</span>
   </span>
 
 

main/setup.html

@@ -908,16 +908,31 @@
 
 
 <h1 id="test-transparent-data-encryption">Test Transparent Data Encryption<a class="headerlink" href="#test-transparent-data-encryption" title="Permanent link">&para;</a></h1>
+<p>To check if the data is encrypted, do the following:</p>
+<div class="tabbed-set tabbed-alternate" data-tabs="1:1"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">pg_tde Tech preview</label></div>
+<div class="tabbed-content">
+<div class="tabbed-block">
 <div class="admonition warning">
 <p class="admonition-title">Warning</p>
 <p>This is the tech preview functionality. Its scope is not yet finalized and can change anytime.<strong> Use it only for testing purposes.</strong></p>
 </div>
+</div>
+</div>
+</div>
 <p>To check if the data is encrypted, do the following:</p>
 <ol>
 <li>
 <p>Create a table in the database for which you have <a href="setup.html">enabled <code>pg_tde</code></a>. Enabling <code>pg_tde</code>    extension creates the table access method <code>tde_heap</code>. To enable data encryption, create the table using this access method as follows:</p>
 <div class="highlight"><pre><span></span><code><span class="k">CREATE</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="o">&lt;</span><span class="k">table_name</span><span class="o">&gt;</span><span class="w"> </span><span class="p">(</span><span class="o">&lt;</span><span class="n">field</span><span class="o">&gt;</span><span class="w"> </span><span class="o">&lt;</span><span class="n">datatype</span><span class="o">&gt;</span><span class="p">)</span><span class="w"> </span><span class="k">USING</span><span class="w"> </span><span class="n">tde_heap</span><span class="p">;</span>
 </code></pre></div>
+<p><i warning><span class="twemoji"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 0 0 2 12a10 10 0 0 0 10 10 10 10 0 0 0 10-10A10 10 0 0 0 12 2"/></svg></span> Warning:</i> Example for testing purposes only:</p>
+<div class="highlight"><pre><span></span><code><span class="k">CREATE</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="n">albums</span><span class="w"> </span><span class="p">(</span>
+<span class="n">album_id</span><span class="w"> </span><span class="nb">INTEGER</span><span class="w"> </span><span class="k">GENERATED</span><span class="w"> </span><span class="n">ALWAYS</span><span class="w"> </span><span class="k">AS</span><span class="w"> </span><span class="k">IDENTITY</span><span class="w"> </span><span class="k">PRIMARY</span><span class="w"> </span><span class="k">KEY</span><span class="p">,</span>
+<span class="n">artist_id</span><span class="w"> </span><span class="nb">INTEGER</span><span class="p">,</span>
+<span class="n">title</span><span class="w"> </span><span class="nb">TEXT</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">NULL</span><span class="p">,</span>
+<span class="n">released</span><span class="w"> </span><span class="nb">DATE</span><span class="w"> </span><span class="k">NOT</span><span class="w"> </span><span class="k">NULL</span>
+<span class="p">)</span><span class="w"> </span><span class="k">USING</span><span class="w"> </span><span class="n">tde_heap</span><span class="p">;</span>
+</code></pre></div>
 </li>
 <li>
 <p>Run the following function:</p>
@@ -934,6 +949,11 @@ <h1 id="test-transparent-data-encryption">Test Transparent Data Encryption<a cla
 <span class="k">SELECT</span><span class="w"> </span><span class="n">pg_tde_rotate_principal_key</span><span class="p">(</span><span class="s1">&#39;new-principal-key&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;new-provider&#39;</span><span class="p">);</span><span class="w"> </span><span class="c1">-- changeprovider</span>
 </code></pre></div>
 </li>
+<li>
+<p>You can encrypt existing table. It requires rewriting the table, so for large tables, it might take a considerable amount of time.</p>
+<div class="highlight"><pre><span></span><code><span class="k">ALTER</span><span class="w"> </span><span class="k">TABLE</span><span class="w"> </span><span class="k">table_name</span><span class="w"> </span><span class="k">SET</span><span class="w"> </span><span class="k">access</span><span class="w"> </span><span class="k">method</span><span class="w">  </span><span class="n">tde_heap</span><span class="p">;</span>
+</code></pre></div>
+</li>
 </ol>
 <div class="admonition hint">
 <p class="admonition-title">Hint</p>
@@ -972,7 +992,7 @@ <h2 class="title" id="get-expert-help">Get expert help<a class="headerlink" href
     <span class="md-icon" title="Last update">
       <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
     </span>
-    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 7, 2024</span>
+    <span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">November 8, 2024</span>
   </span>