scale-catalog/old-website/manual/SCALE Apps/Quick-Start Guides/15-pvc-access/index.html

13 lines
378 KiB
HTML
Raw Normal View History

<!doctype html><html lang=en class=no-js> <head><meta charset=utf-8><meta name=viewport content="width=device-width,initial-scale=1"><meta name=description content="Project Documentation for TrueCharts"><meta name=author content="TrueCharts Team"><link href=https://truecharts.org/manual/SCALE%20Apps/Quick-Start%20Guides/15-pvc-access/ rel=canonical><link rel=icon href=../../../../_static/img/favicon.png><meta name=generator content="mkdocs-1.3.0, mkdocs-material-8.3.8"><title>15 - Accessing PVC Data - TrueCharts</title><link rel=stylesheet href=../../../../assets/stylesheets/main.1d29e8d0.min.css><link rel=stylesheet href=../../../../assets/stylesheets/palette.cbb835fc.min.css><link rel=preconnect href=https://fonts.gstatic.com crossorigin><link rel=stylesheet href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback"><style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style><link rel=stylesheet href=../../../../_static/custom.css><script>__md_scope=new URL("../../../..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script><script>function gtag(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],gtag("js",new Date),gtag("config","G-6G6694723V"),document.addEventListener("DOMContentLoaded",function(){document.forms.search&&document.forms.search.query.addEventListener("blur",function(){this.value&&gtag("event","search",{search_term:this.value})}),"undefined"!=typeof location$&&location$.subscribe(function(e){gtag("config","G-6G6694723V",{page_path:e.pathname})})})</script><script async src="https://www.googletagmanager.com/gtag/js?id=G-6G6694723V"></script></head> <body dir=ltr data-md-color-scheme data-md-color-primary=none data-md-color-accent=none> <input class=md-toggle data-md-toggle=drawer type=checkbox id=__drawer autocomplete=off> <input class=md-toggle data-md-toggle=search type=checkbox id=__search autocomplete=off> <label class=md-overlay for=__drawer></label> <div data-md-component=skip> <a href=#15-accessing-pvc-data class=md-skip> Skip to content </a> </div> <div data-md-component=announce> </div> <header class=md-header data-md-component=header> <nav class="md-header__inner md-grid" aria-label=Header> <a href=../../../.. title=TrueCharts class="md-header__button md-logo" aria-label=TrueCharts data-md-component=logo> <img src=../../../../_static/img/logo1024.png alt=logo> </a> <label class="md-header__button md-icon" for=__drawer> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg> </label> <div class=md-header__title data-md-component=header-title> <div class=md-header__ellipsis> <div class=md-header__topic> <span class=md-ellipsis> TrueCharts </span> </div> <div class=md-header__topic data-md-component=header-topic> <span class=md-ellipsis> 15 - Accessing PVC Data </span> </div> </div> </div> <div class=md-header__source> <a href=https://github.com/truecharts/pub title="Go to repository" class=md-source data-md-component=source> <div class="md-source__icon md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 480 512"><!-- Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3
</code></pre></div> <p><br></p> <p>3. <strong>Find the application you would like to mount</strong></p> <p>This can be confusing at first because many applications will have many different instances of PVC.</p> <p><a href=https://truecharts.org/_static/img/pvc_access/pvc_list.png><img src=https://truecharts.org/_static/img/pvc_access/pvc_list.png width=100%></a></p> <ul> <li>You'll see in this photo, Nextcloud has many different PVC's.<ul> <li>However, if you break it down by looking at the middle column, it's not too confusing.</li> <li><code>data-nextcloud-redis-0</code><ul> <li>This is your Redis PVC</li> </ul> </li> <li><code>db-nextcloud-postgresql-0</code><ul> <li>This is your PostgreSQL PVC</li> </ul> </li> <li><code>nextcloud-data</code><ul> <li>This is your Data PVC</li> </ul> </li> </ul> </li> </ul> <p><br></p> <p>4. <strong>After finding which PVC you would like to mount, copy the far right column (The Volume) that starts with pvc- into a notepad for use in the next command</strong></p> <ul> <li>If I was wanting to mount <code>nextcloud-data</code>, I would use:</li> <li><code>pvc-cd84394b-7812-43c3-a6d9-1a5693592cbe</code></li> </ul> <p><br></p> <p>5. <strong>Run the following command to find the full path to your applications PVC</strong></p> <div class=highlight><pre><span></span><code>zfs list <span class=p>|</span> grep PVC_VOLUME
</code></pre></div> <ul> <li>Going off of the Nextcloud example, I would simply replace <code>PVC_VOLUME</code> with <code>pvc-cd84394b-7812-43c3-a6d9-1a5693592cbe</code></li> </ul> <p>Example: </p> <div class=highlight><pre><span></span><code>zfs list <span class=p>|</span> grep pvc-cd84394b-7812-43c3-a6d9-1a5693592cbe
</code></pre></div> <p>Here is what the output should look like <a href=https://truecharts.org/_static/img/pvc_access/nextcloud_volumes.png><img src=https://truecharts.org/_static/img/pvc_access/nextcloud_volumes.png width=100%></a></p> <p><br></p> <p>6. <strong>Mount your PVC</strong></p> <div class=highlight><pre><span></span><code>zfs <span class=nb>set</span> <span class=nv>mountpoint</span><span class=o>=</span>/temporary/NAME FULL_PVC_PATH
</code></pre></div> <p>Example: </p> <div class=highlight><pre><span></span><code>zfs <span class=nb>set</span> <span class=nv>mountpoint</span><span class=o>=</span>/temporary/nextcloud-data speed/ix-applications/releases/nextcloud/volumes/pvc-cd84394b-7812-43c3-a6d9-1a5693592cbe
</code></pre></div> <ul> <li>This command will produce no output if it's successful</li> <li>Now you should be able to do whatever you want within the app's PVC</li> </ul> <p><br> <br> <br> <br></p> <h4 id=remounting><strong>Remounting</strong> <a name=paragraph3></a><a class=headerlink href=#remounting title="Permanent link">&para;</a></h4> <div class=highlight><pre><span></span><code>zfs <span class=nb>set</span> <span class=nv>mountpoint</span><span class=o>=</span>legacy POOL_NAME/ix-applications/releases/APPLICATION_NAME/volumes/VOLUME-NAME
</code></pre></div> <p>Example:</p> <div class=highlight><pre><span></span><code>zfs <span class=nb>set</span> <span class=nv>mountpoint</span><span class=o>=</span>legacy speed/ix-applications/releases/nextcloud/volumes/pvc-cd84394b-7812-43c3-a6d9-1a5693592cbe
</code></pre></div> <p><br></p> <p>Afterwards, I always like to <code>rmdir</code> on the directory that was created when mounting </p> <ul> <li>In my case I would run:</li> </ul> <div class=highlight><pre><span></span><code>rmdir /mnt/temporary/nextcloud-data
</code></pre></div> <ul> <li> <p>This just helps keep your temporary folder clean, and lets you know what is or is not currently mounted.</p> </li> <li> <p>Do not worry, <code>rmdir</code> cannot delete mounted folders, or folders with contents in them.</p> </li> </ul> <p><br> <br> <br> <br></p> <h2 id=manual-method-advanced-user-guide>Manual Method - Advanced User Guide <a name=paragraph4></a><a class=headerlink href=#manual-method-advanced-user-guide title="Permanent link">&para;</a></h2> <h4 id=always-make-sure-the-app-is-stopped-while-mounting-the-pvc><strong>ALWAYS MAKE SURE THE APP IS STOPPED WHILE MOUNTING THE PVC</strong><a class=headerlink href=#always-make-sure-the-app-is-stopped-while-mounting-the-pvc title="Permanent link">&para;</a></h4> <h4 id=to-get-the-pvcname>To get the PVCNAME:<a class=headerlink href=#to-get-the-pvcname title="Permanent link">&para;</a></h4> <div class=highlight><pre><span></span><code>k3s kubectl get pvc -n ix-APPNAME
</code></pre></div> <p><br></p> <h4 id=to-get-the-pvcpath>To get the PVCPATH:<a class=headerlink href=#to-get-the-pvcpath title="Permanent link">&para;</a></h4> <div class=highlight><pre><span></span><code>zfs list <span class=p>|</span> grep legacy <span class=p>|</span> grep APPNAME
</code></pre></div> <p><br></p> <h4 id=if-you-want-to-mount-the-pvc-content>If you want to mount the PVC content:<a class=headerlink href=#if-you-want-to-mount-the-pvc-content title="Permanent link">&para;</a></h4> <div class=highlight><pre><span></span><code>zfs <span class=nb>set</span> <span class=nv>mountpoint</span><span class=o>=</span>/temporary PVCPATH
</code></pre></div> <p>Your PVC will be mounted under <code>/mnt/temporary</code> <br> <br></p> <h4 id=and-when-youre-done-editing>and when you're done editing:<a class=headerlink href=#and-when-youre-done-editing title="Permanent link">&para;</a></h4> <div class=highlight><pre><span></span><code>zfs <span class=nb>set</span> <span class=nv>mountpoint</span><span class=o>=</span>legacy PVCPATH
</code></pre></div> </article> </div> </div> </main> <footer class=md-footer> <nav class="md-footer__inner md-grid" aria-label=Footer> <a href=../14-backup-restore/ class="md-footer__link md-footer__link--prev" aria-label="Previous: 14 - Backup and Restore" rel=prev> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg> </div> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Previous </span> 14 - Backup and Restore </div> </div> </a> <a href=../../indepth/certificates/ class="md-footer__link md-footer__link--next" aria-label="Next: How to: Create Certificates" rel=next> <div class=md-footer__title> <div class=md-ellipsis> <span class=md-footer__direction> Next </span> How to: Create Certificates </div> </div> <div class="md-footer__button md-icon"> <svg xmlns=http://www.w3.org/2000/svg viewbox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg> </div> </a> </nav> <div class="md-footer-meta md-typeset"> <div class="md-footer-meta__inner md-grid"> <div class=md-copyright> <div class=md-copyright__highlight> Copyright &copy; 2020 - 2022 The TrueCharts Project </div> </div> </div> </div> </footer> </div> <div class=md-dialog data-md-component=dialog> <div class="md-dialog__inner md-typeset"></div> </div> <script id=__config type=application/json>{"base": "../../../..", "features": ["navigation.tabs", "navigation.tracking", "navigation.instant", "search.highlight", "search.share", "search.suggest"], "search": "../../../../assets/javascripts/workers/search.b97dbffb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> <script src=../../../../assets/javascripts/bundle.0238f547.min.js></script> </body> </html>