
  



  
  <section id="common-setup-for-snowpark-container-services-tutorials">
<h1>Common Setup for Snowpark Container Services Tutorials<a class="headerlink" href="#common-setup-for-snowpark-container-services-tutorials" title="Link to this heading" data-nosnippet="">¶</a></h1>
<aside class="newfeat sidebar">
<p class="sidebar-title"><a class="image-small reference internal" href="../../../_images/logo-snowflake-black.png"><img alt="Snowflake logo in black (no text)" class="image-small" src="../../../_images/logo-snowflake-black.png" style="width: 15px; height: 15px;"></a> Feature — Generally Available</p>
<p>Snowpark Container Services is available to accounts in <a class="reference internal" href="../../../user-guide/intro-regions.html#label-na-general-regions"><span class="std std-ref">AWS, Microsoft Azure, and Google Cloud Platform commercial regions</span></a>, with some exceptions. For more information, see <a class="reference internal" href="../overview.html#label-snowpark-containers-overview-available-regions"><span class="std std-ref">Available regions and considerations</span></a>.</p>
</aside>

<section id="introduction">
<h2>Introduction<a class="headerlink" href="#introduction" title="Link to this heading" data-nosnippet="">¶</a></h2>
<p>This topic provides instructions for the common setup required for all Snowpark Container Services tutorials provided in this
documentation.</p>
</section>
<section id="configure-prerequisites">
<h2>Configure prerequisites<a class="headerlink" href="#configure-prerequisites" title="Link to this heading" data-nosnippet="">¶</a></h2>
<p>Review the following prerequisites to ensure you can complete the tutorials:</p>
<ul class="simple">
<li><p><strong>A Snowflake account:</strong> Note that trial accounts are not supported.</p></li>
<li><p><strong>SnowSQL, the command-line client for executing SQL commands (optional):</strong> You can use any Snowflake client that supports
executing SQL commands and uploading files to a Snowflake stage. The tutorials are tested using the SnowSQL and the
<a class="reference internal" href="../../../user-guide/ui-snowsight-gs.html#label-snowsight-getting-started-sign-in"><span class="std std-ref">Snowsight</span></a> web interface. For instructions to install this command-line client, see
<a class="reference internal" href="../../../user-guide/snowsql-install-config"><span class="doc">Installing SnowSQL</span></a>.</p></li>
<li><p><strong>Docker Desktop:</strong> These tutorials provide instructions for using Docker Desktop. For installation instructions, see
<a class="reference external" href="https://docs.docker.com/get-docker/">https://docs.docker.com/get-docker/</a>.  Note that you can use any OCI-compliant clients to create images, such as Docker, Podman,
or Nerdctl.</p></li>
</ul>
</section>
<section id="create-snowflake-objects">
<span id="label-snowpark-containers-common-setup-create-objects"></span><h2>Create Snowflake objects<a class="headerlink" href="#create-snowflake-objects" title="Link to this heading" data-nosnippet="">¶</a></h2>
<p>Execute the SQL provided using either the SnowSQL or the Snowsight.</p>
<ol class="arabic">
<li><p>Login to Snowflake as a user with the ACCOUNTADMIN role.</p></li>
<li><p>Using the ACCOUNTADMIN role, execute the following script, replacing <code class="samp docutils literal notranslate"><em><span class="pre">user_name</span></em></code> with the name of your Snowflake user who will test the tutorials. For these tutorials, you might choose the same user who executes this script or another user in your Snowflake account. The script does the following:</p>
<ul class="simple">
<li><p>Creates a role (<code class="docutils literal notranslate"><span class="pre">test_role</span></code>) and other Snowflake objects. To create the role and objects, you must use the ACCOUNTADMIN role.
(This restriction helps to control costs and manage business information risks.) The script also grants the <code class="docutils literal notranslate"><span class="pre">test_role</span></code> role
the privileges needed to manage the newly created objects.</p></li>
<li><p>Grants the role to the specified Snowflake user, who then uses the role to explore the tutorials.</p></li>
</ul>
<div class="relative group text-sm"><div class="highlight-sqlexample notranslate"><div class="highlight"><pre><span></span><span class="ni">USE</span> <span class="ni">ROLE</span> <span class="ni">ACCOUNTADMIN</span><span class="p">;</span>

<span class="ni">CREATE</span> <span class="ni">ROLE</span> <span class="gi">test_role</span><span class="p">;</span>

<span class="ni">CREATE</span> <span class="ni">DATABASE</span> <span class="ni">IF</span> <span class="ni">NOT</span> <span class="ni">EXISTS</span> <span class="gi">tutorial_db</span><span class="p">;</span>
<span class="ni">GRANT</span> <span class="ni">OWNERSHIP</span> <span class="ni">ON</span> <span class="ni">DATABASE</span> <span class="gi">tutorial_db</span> <span class="ni">TO</span> <span class="ni">ROLE</span> <span class="gi">test_role</span> <span class="ni">COPY</span> <span class="ni">CURRENT</span> <span class="ni">GRANTS</span><span class="p">;</span>

<span class="ni">CREATE</span> <span class="ni">OR</span> <span class="ni">REPLACE</span> <span class="ni">WAREHOUSE</span> <span class="gi">tutorial_warehouse</span> <span class="ni">WITH</span>
  <span class="ni">WAREHOUSE_SIZE</span><span class="p">=</span><span class="nc">'X-SMALL'</span><span class="p">;</span>
<span class="ni">GRANT</span> <span class="ni">USAGE</span> <span class="ni">ON</span> <span class="ni">WAREHOUSE</span> <span class="gi">tutorial_warehouse</span> <span class="ni">TO</span> <span class="ni">ROLE</span> <span class="gi">test_role</span><span class="p">;</span>

<span class="ni">GRANT</span> <span class="ni">BIND SERVICE ENDPOINT</span> <span class="ni">ON</span> <span class="ni">ACCOUNT</span> <span class="ni">TO</span> <span class="ni">ROLE</span> <span class="gi">test_role</span><span class="p">;</span>

<span class="ni">CREATE</span> <span class="ni">COMPUTE POOL</span> <span class="gi">tutorial_compute_pool</span>
  <span class="ni">MIN_NODES</span> <span class="p">=</span> <span class="nf">1</span>
  <span class="ni">MAX_NODES</span> <span class="p">=</span> <span class="nf">1</span>
  <span class="ni">INSTANCE_FAMILY</span> <span class="p">=</span> <span class="gi">CPU_X64_XS</span><span class="p">;</span>
<span class="ni">GRANT</span> <span class="ni">USAGE</span><span class="p">,</span> <span class="ni">MONITOR</span> <span class="ni">ON</span> <span class="ni">COMPUTE POOL</span> <span class="gi">tutorial_compute_pool</span> <span class="ni">TO</span> <span class="ni">ROLE</span> <span class="gi">test_role</span><span class="p">;</span>

<span class="ni">GRANT</span> <span class="ni">ROLE</span> <span class="gi">test_role</span> <span class="ni">TO</span> <span class="ni">USER</span> <span class="p">&lt;</span><span class="ni">user_name</span><span class="p">&gt;</span>
</pre></div>
</div><div data-codeblock-index="0" class="copybutton"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 384 512" class="copybutton-icon icon-copy"><path d="M192 0c-41.8 0-77.4 26.7-90.5 64H64C28.7 64 0 92.7 0 128V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V128c0-35.3-28.7-64-64-64H282.5C269.4 26.7 233.8 0 192 0zm0 64a32 32 0 1 1 0 64 32 32 0 1 1 0-64zM112 192H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 512" class="copybutton-icon icon-copied hidden"><path d="M470.6 105.4c12.5 12.5 12.5 32.8 0 45.3l-256 256c-12.5 12.5-32.8 12.5-45.3 0l-128-128c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0L192 338.7 425.4 105.4c12.5-12.5 32.8-12.5 45.3 0z"></path></svg><span>Copy</span></div></div>
<p>Note that:</p>
<ul class="simple">
<li><p>You create a warehouse because the services (including job services) can run SQL DML statements (such as SELECT and INSERT). Snowflake executes these statements in the warehouse.</p></li>
<li><p>In tutorial 1, you create a service that exposes an endpoint as public to allow users to access the service from the public web (ingress). To create this service:</p>
<ul>
<li><p>The role <code class="code docutils literal notranslate"><span class="pre">test_role</span></code> must have the BIND SERVICE ENDPOINT privilege on the account.</p></li>
<li><p>The current implementation requires a security integration, which the script creates.</p></li>
</ul>
</li>
<li><p>A <a class="reference internal" href="../working-with-compute-pool"><span class="doc">compute pool</span></a> is a collection of one or more virtual machine (VM) nodes on which Snowflake runs your services.</p></li>
</ul>
</li>
<li><p>Make sure you are logged in to Snowflake as the user specified in the preceding script.</p></li>
<li><p>Using the <code class="code docutils literal notranslate"><span class="pre">test_role</span></code> role, execute the following script to create database-scoped objects common to all the tutorials.</p>
<div class="relative group text-sm"><div class="highlight-sqlexample notranslate"><div class="highlight"><pre><span></span><span class="ni">USE</span> <span class="ni">ROLE</span> <span class="gi">test_role</span><span class="p">;</span>
<span class="ni">USE</span> <span class="ni">DATABASE</span> <span class="gi">tutorial_db</span><span class="p">;</span>
<span class="ni">USE</span> <span class="ni">WAREHOUSE</span> <span class="gi">tutorial_warehouse</span><span class="p">;</span>

<span class="ni">CREATE</span> <span class="ni">SCHEMA</span> <span class="ni">IF</span> <span class="ni">NOT</span> <span class="ni">EXISTS</span> <span class="gi">data_schema</span><span class="p">;</span>
<span class="ni">CREATE</span> <span class="ni">IMAGE REPOSITORY</span> <span class="ni">IF</span> <span class="ni">NOT</span> <span class="ni">EXISTS</span> <span class="gi">tutorial_repository</span><span class="p">;</span>
<span class="ni">CREATE</span> <span class="ni">STAGE</span> <span class="ni">IF</span> <span class="ni">NOT</span> <span class="ni">EXISTS</span> <span class="gi">tutorial_stage</span>
  <span class="ni">DIRECTORY</span> <span class="p">=</span> <span class="p">(</span> <span class="ni">ENABLE</span> <span class="p">=</span> <span class="ni">true</span> <span class="p">);</span>
</pre></div>
</div><div data-codeblock-index="1" class="copybutton"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 384 512" class="copybutton-icon icon-copy"><path d="M192 0c-41.8 0-77.4 26.7-90.5 64H64C28.7 64 0 92.7 0 128V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V128c0-35.3-28.7-64-64-64H282.5C269.4 26.7 233.8 0 192 0zm0 64a32 32 0 1 1 0 64 32 32 0 1 1 0-64zM112 192H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 512" class="copybutton-icon icon-copied hidden"><path d="M470.6 105.4c12.5 12.5 12.5 32.8 0 45.3l-256 256c-12.5 12.5-32.8 12.5-45.3 0l-128-128c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0L192 338.7 425.4 105.4c12.5-12.5 32.8-12.5 45.3 0z"></path></svg><span>Copy</span></div></div>
<p>Note that:</p>
<ul class="simple">
<li><p>You create an image repository to store your service code (container images).</p></li>
<li><p>You create a Snowflake stage to store your service specification files in tutorial 2 and 3.</p></li>
</ul>
</li>
</ol>
</section>
<section id="verify-that-you-are-ready-to-continue">
<span id="label-snowpark-containers-common-setup-verify-ready"></span><h2>Verify that you are ready to continue<a class="headerlink" href="#verify-that-you-are-ready-to-continue" title="Link to this heading" data-nosnippet="">¶</a></h2>
<ol class="arabic">
<li><p>To verify that you have the objects needed for the tutorials, execute the following commands:</p>
<div class="relative group text-sm"><div class="highlight-sqlexample notranslate"><div class="highlight"><pre><span></span><span class="ni">SHOW</span> <span class="ni">COMPUTE</span> <span class="ni">POOLS</span><span class="p">;</span> <span class="py">--or DESCRIBE COMPUTE POOL tutorial_compute_pool;</span>
</pre></div>
</div><div data-codeblock-index="2" class="copybutton"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 384 512" class="copybutton-icon icon-copy"><path d="M192 0c-41.8 0-77.4 26.7-90.5 64H64C28.7 64 0 92.7 0 128V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V128c0-35.3-28.7-64-64-64H282.5C269.4 26.7 233.8 0 192 0zm0 64a32 32 0 1 1 0 64 32 32 0 1 1 0-64zM112 192H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 512" class="copybutton-icon icon-copied hidden"><path d="M470.6 105.4c12.5 12.5 12.5 32.8 0 45.3l-256 256c-12.5 12.5-32.8 12.5-45.3 0l-128-128c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0L192 338.7 425.4 105.4c12.5-12.5 32.8-12.5 45.3 0z"></path></svg><span>Copy</span></div></div>
<div class="relative group text-sm"><div class="highlight-sqlexample notranslate"><div class="highlight"><pre><span></span><span class="ni">SHOW WAREHOUSES</span><span class="p">;</span>
</pre></div>
</div><div data-codeblock-index="3" class="copybutton"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 384 512" class="copybutton-icon icon-copy"><path d="M192 0c-41.8 0-77.4 26.7-90.5 64H64C28.7 64 0 92.7 0 128V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V128c0-35.3-28.7-64-64-64H282.5C269.4 26.7 233.8 0 192 0zm0 64a32 32 0 1 1 0 64 32 32 0 1 1 0-64zM112 192H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 512" class="copybutton-icon icon-copied hidden"><path d="M470.6 105.4c12.5 12.5 12.5 32.8 0 45.3l-256 256c-12.5 12.5-32.8 12.5-45.3 0l-128-128c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0L192 338.7 425.4 105.4c12.5-12.5 32.8-12.5 45.3 0z"></path></svg><span>Copy</span></div></div>
<div class="relative group text-sm"><div class="highlight-sqlexample notranslate"><div class="highlight"><pre><span></span><span class="ni">SHOW</span> <span class="ni">IMAGE REPOSITORIES</span><span class="p">;</span>
</pre></div>
</div><div data-codeblock-index="4" class="copybutton"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 384 512" class="copybutton-icon icon-copy"><path d="M192 0c-41.8 0-77.4 26.7-90.5 64H64C28.7 64 0 92.7 0 128V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V128c0-35.3-28.7-64-64-64H282.5C269.4 26.7 233.8 0 192 0zm0 64a32 32 0 1 1 0 64 32 32 0 1 1 0-64zM112 192H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 512" class="copybutton-icon icon-copied hidden"><path d="M470.6 105.4c12.5 12.5 12.5 32.8 0 45.3l-256 256c-12.5 12.5-32.8 12.5-45.3 0l-128-128c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0L192 338.7 425.4 105.4c12.5-12.5 32.8-12.5 45.3 0z"></path></svg><span>Copy</span></div></div>
<div class="relative group text-sm"><div class="highlight-sqlexample notranslate"><div class="highlight"><pre><span></span><span class="ni">SHOW</span> <span class="ni">STAGES</span><span class="p">;</span>
</pre></div>
</div><div data-codeblock-index="5" class="copybutton"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 384 512" class="copybutton-icon icon-copy"><path d="M192 0c-41.8 0-77.4 26.7-90.5 64H64C28.7 64 0 92.7 0 128V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V128c0-35.3-28.7-64-64-64H282.5C269.4 26.7 233.8 0 192 0zm0 64a32 32 0 1 1 0 64 32 32 0 1 1 0-64zM112 192H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 512" class="copybutton-icon icon-copied hidden"><path d="M470.6 105.4c12.5 12.5 12.5 32.8 0 45.3l-256 256c-12.5 12.5-32.8 12.5-45.3 0l-128-128c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0L192 338.7 425.4 105.4c12.5-12.5 32.8-12.5 45.3 0z"></path></svg><span>Copy</span></div></div>
</li>
<li><p>To verify that you have your account information (organization and account names), use one of the following methods:</p>
<ul>
<li><p>Find the information on the Snowsight web interface, in the lower left corner of the Home page.</p></li>
<li><p>In the SnowSQL CLI, execute SHOW IMAGE REPOSITORIES. The command returns the repository URL, including the organization and
account names.</p>
<p><strong>Example</strong></p>
<div class="relative group text-sm"><div class="highlight-sqlexample notranslate"><div class="highlight"><pre><span></span><span class="p">&lt;</span><span class="gi">orgname</span><span class="p">&gt;-&lt;</span><span class="gi">acctname</span><span class="p">&gt;.</span><span class="gi">registry</span><span class="p">.</span><span class="gi">snowflakecomputing</span><span class="p">.</span><span class="gi">com</span><span class="p">/</span><span class="gi">tutorial_db</span><span class="p">/</span><span class="gi">data_schema</span><span class="p">/</span><span class="gi">tutorial_repository</span>
</pre></div>
</div><div data-codeblock-index="6" class="copybutton"><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 384 512" class="copybutton-icon icon-copy"><path d="M192 0c-41.8 0-77.4 26.7-90.5 64H64C28.7 64 0 92.7 0 128V448c0 35.3 28.7 64 64 64H320c35.3 0 64-28.7 64-64V128c0-35.3-28.7-64-64-64H282.5C269.4 26.7 233.8 0 192 0zm0 64a32 32 0 1 1 0 64 32 32 0 1 1 0-64zM112 192H272c8.8 0 16 7.2 16 16s-7.2 16-16 16H112c-8.8 0-16-7.2-16-16s7.2-16 16-16z"></path></svg><svg xmlns="http://www.w3.org/2000/svg" viewbox="0 0 512 512" class="copybutton-icon icon-copied hidden"><path d="M470.6 105.4c12.5 12.5 12.5 32.8 0 45.3l-256 256c-12.5 12.5-32.8 12.5-45.3 0l-128-128c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0L192 338.7 425.4 105.4c12.5-12.5 32.8-12.5 45.3 0z"></path></svg><span>Copy</span></div></div>
</li>
</ul>
</li>
</ol>
<section id="what-s-next">
<span id="label-snowpark-containers-tutorials-common-setup-what-next"></span><h3>What’s next?<a class="headerlink" href="#what-s-next" title="Link to this heading" data-nosnippet="">¶</a></h3>
<p>You can now explore <a class="reference internal" href="tutorial-1"><span class="doc">Tutorial 1</span></a>.</p>
</section>
</section>
</section>




This tutorial provides instructions for the common setup required for all Snowpark Container Services tutorials.