Modified: jclouds/site-content/guides/go-grid/index.html URL: http://svn.apache.org/viewvc/jclouds/site-content/guides/go-grid/index.html?rev=1923693&r1=1923692&r2=1923693&view=diff ============================================================================== --- jclouds/site-content/guides/go-grid/index.html (original) +++ jclouds/site-content/guides/go-grid/index.html Mon Feb 10 07:25:53 2025 @@ -149,60 +149,50 @@ <div class="page-header"> <h1>Go Grid: Getting Started Guide</h1> </div> - <p>Starting with jclouds 1.0 beta 5, we're supporting <a href="http://www.gogrid.com";>GoGrid</a> cloud provider, + <p>Starting with jclouds 1.0 beta 5, weâre supporting <a href="http://www.gogrid.com";>GoGrid</a> cloud provider, both for the provider-specific APIs and for [[ComputeService]] abstraction.</p> -<h3>Important notes</h3> +<h3 id="important-notes">Important notes</h3> <p>To use GoGrid, please make sure your have the <em>key</em> and <em>shared secret</em>. -Both can be created/obtained from GoGrid's control panel under My Account > API keys. +Both can be created/obtained from GoGridâs control panel under My Account > API keys. The key is typically 16 digits, and the shared secret is 12 digits, but yours may be different. -Using your account's email address won't substitute the key and won't let you access their APIs.</p> +Using your accountâs email address wonât substitute the key and wonât let you access their APIs.</p> -<h3>Using provider-specific API</h3> +<h3 id="using-provider-specific-api">Using provider-specific API</h3> <p>To create a context for all subsequent API calls, use:</p> -<div class="highlight"><pre><code class="java"><span class="n">RestContext</span><span class="o"><</span><span class="n">GoGridClient</span><span class="o">,</span> <span class="n">GoGridAsyncClient</span><span class="o">></span> <span class="n">context</span> <span class="o">=</span> - <span class="n">ContextBuilder</span><span class="o">.</span><span class="na">newBuilder</span><span class="o">(</span><span class="s">"gogrid"</span><span class="o">)</span> +<figure class="highlight"><pre><code class="language-java" data-lang="java"><span class="nc">RestContext</span><span class="o"><</span><span class="nc">GoGridClient</span><span class="o">,</span> <span class="nc">GoGridAsyncClient</span><span class="o">></span> <span class="n">context</span> <span class="o">=</span> + <span class="nc">ContextBuilder</span><span class="o">.</span><span class="na">newBuilder</span><span class="o">(</span><span class="s">"gogrid"</span><span class="o">)</span> <span class="o">.</span><span class="na">credentials</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">sharedSecret</span><span class="o">)</span> - <span class="o">.</span><span class="na">modules</span><span class="o">(</span><span class="n">ImmutableSet</span><span class="o">.<</span><span class="n">Module</span><span class="o">></span> <span class="n">of</span><span class="o">(</span><span class="k">new</span> <span class="n">Log4JLoggingModule</span><span class="o">(),</span> + <span class="o">.</span><span class="na">modules</span><span class="o">(</span><span class="nc">ImmutableSet</span><span class="o">.<</span><span class="nc">Module</span><span class="o">></span> <span class="nf">of</span><span class="o">(</span><span class="k">new</span> <span class="nc">Log4JLoggingModule</span><span class="o">(),</span> <span class="k">new</span> <span class="nf">SshjSshClientModule</span><span class="o">()))</span> - <span class="o">.</span><span class="na">buildView</span><span class="o">(</span><span class="n">ComputeServiceContext</span><span class="o">.</span><span class="na">class</span><span class="o">)</span> - <span class="o">.</span><span class="na">getProviderSpecificContext</span><span class="o">();</span> + <span class="o">.</span><span class="na">buildView</span><span class="o">(</span><span class="nc">ComputeServiceContext</span><span class="o">.</span><span class="na">class</span><span class="o">)</span> + <span class="o">.</span><span class="na">getProviderSpecificContext</span><span class="o">();</span> -<span class="n">GoGridClient</span> <span class="n">client</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="na">getApi</span><span class="o">();</span> -</code></pre></div> +<span class="nc">GoGridClient</span> <span class="n">client</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="na">getApi</span><span class="o">();</span></code></pre></figure> +<figure class="highlight"><pre><code class="language-java" data-lang="java"><span class="c1">// make an API call to get the IPs</span> +<span class="nc">Set</span><span class="o"><</span><span class="nc">Ip</span><span class="o">></span> <span class="n">availableIps</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">getIpServices</span><span class="o">().</span><span class="na">getUnassignedIpList</span><span class="o">();</span> - - -<div class="highlight"><pre><code class="java"><span class="c1">// make an API call to get the IPs</span> -<span class="n">Set</span><span class="o"><</span><span class="n">Ip</span><span class="o">></span> <span class="n">availableIps</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">getIpServices</span><span class="o">().</span><span class="na">getUnassignedIpList</span><span class="o">();</span> - -<span class="c1">// iterate over the collection. you're not required to use Iterables</span> -<span class="n">Ip</span> <span class="n">availableIp</span> <span class="o">=</span> <span class="n">Iterables</span><span class="o">.</span><span class="na">getLast</span><span class="o">(</span><span class="n">availableIps</span><span class="o">);</span> -</code></pre></div> - +<span class="c1">// iterate over the collection. you're not required to use Iterables</span> +<span class="nc">Ip</span> <span class="n">availableIp</span> <span class="o">=</span> <span class="nc">Iterables</span><span class="o">.</span><span class="na">getLast</span><span class="o">(</span><span class="n">availableIps</span><span class="o">);</span></code></pre></figure> <p>Having an available IP address, you can create a server:</p> -<div class="highlight"><pre><code class="java"><span class="n">Server</span> <span class="n">createdServer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">getServerServices</span><span class="o">().</span><span class="na">addServer</span><span class="o">(</span><span class="n">nameOfServer</span><span class="o">,</span> - <span class="s">"GSI-f8979644-e646-4711-ad58-d98a5fa3612c"</span> <span class="cm">/*image name*/</span><span class="o">,</span> - <span class="s">"1"</span> <span class="cm">/*ID of ram, 1 is 512 MB, 2 is 1GB*/</span><span class="o">,</span> - <span class="n">availableIp</span><span class="o">.</span><span class="na">getIp</span><span class="o">());</span> -</code></pre></div> - +<figure class="highlight"><pre><code class="language-java" data-lang="java"><span class="nc">Server</span> <span class="n">createdServer</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">getServerServices</span><span class="o">().</span><span class="na">addServer</span><span class="o">(</span><span class="n">nameOfServer</span><span class="o">,</span> + <span class="s">"GSI-f8979644-e646-4711-ad58-d98a5fa3612c"</span> <span class="cm">/*image name*/</span><span class="o">,</span> + <span class="s">"1"</span> <span class="cm">/*ID of ram, 1 is 512 MB, 2 is 1GB*/</span><span class="o">,</span> + <span class="n">availableIp</span><span class="o">.</span><span class="na">getIp</span><span class="o">());</span></code></pre></figure> -<p>and optionally wait until it fully starts (in GoGrid's terms, until the server creation job is completed):</p> +<p>and optionally wait until it fully starts (in GoGridâs terms, until the server creation job is completed):</p> -<div class="highlight"><pre><code class="java"><span class="n">RetryablePredicate</span><span class="o"><</span><span class="n">Server</span><span class="o">></span> <span class="n">serverLatestJobCompleted</span> <span class="o">=</span> <span class="k">new</span> <span class="n">RetryablePredicate</span><span class="o"><</span><span class="n">Server</span><span class="o">>(</span> +<figure class="highlight"><pre><code class="language-java" data-lang="java"><span class="nc">RetryablePredicate</span><span class="o"><</span><span class="nc">Server</span><span class="o">></span> <span class="n">serverLatestJobCompleted</span> <span class="o">=</span> <span class="k">new</span> <span class="nc">RetryablePredicate</span><span class="o"><</span><span class="nc">Server</span><span class="o">>(</span> <span class="k">new</span> <span class="nf">ServerLatestJobCompleted</span><span class="o">(</span><span class="n">client</span><span class="o">.</span><span class="na">getJobServices</span><span class="o">()),</span> - <span class="mi">800</span><span class="o">,</span> <span class="mi">20</span><span class="o">,</span> <span class="n">TimeUnit</span><span class="o">.</span><span class="na">SECONDS</span><span class="o">);</span> + <span class="mi">800</span><span class="o">,</span> <span class="mi">20</span><span class="o">,</span> <span class="nc">TimeUnit</span><span class="o">.</span><span class="na">SECONDS</span><span class="o">);</span> <span class="n">serverLatestJobCompleted</span><span class="o">.</span><span class="na">apply</span><span class="o">(</span><span class="n">createdServer</span><span class="o">);</span> <span class="c1">//blocks until the condition is met or timeout is exceeded</span> -<span class="c1">// (returns true/false whether it was never met or not)</span> -</code></pre></div> - +<span class="c1">// (returns true/false whether it was never met or not)</span></code></pre></figure> <p>Note that this predicate can be used for any type of server-related jobs (for load balancer-related jobs, please see <a href="https://github.com/apache/jclouds/blob/master/providers/gogrid/src/main/java/org/jclouds/gogrid/predicates/LoadBalancerLatestJobCompleted.java";>this predicate</a>). @@ -210,53 +200,41 @@ Also, GoGrid will mark the server creati <p>To restart the server, or turn it off, a power command with <a href="https://github.com/apache/jclouds/blob/master/providers/gogrid/src/main/java/org/jclouds/gogrid/domain/PowerCommand.java";>PowerCommand</a> enum may be used:</p> -<div class="highlight"><pre><code class="java"><span class="n">client</span><span class="o">.</span><span class="na">getServerServices</span><span class="o">().</span><span class="na">power</span><span class="o">(</span><span class="n">nameOfServer</span><span class="o">,</span> <span class="n">PowerCommand</span><span class="o">.</span><span class="na">RESTART</span><span class="o">);</span> -</code></pre></div> - +<figure class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">client</span><span class="o">.</span><span class="na">getServerServices</span><span class="o">().</span><span class="na">power</span><span class="o">(</span><span class="n">nameOfServer</span><span class="o">,</span> <span class="nc">PowerCommand</span><span class="o">.</span><span class="na">RESTART</span><span class="o">);</span></code></pre></figure> <p>Deleting an existing server is accomplished by calling:</p> -<div class="highlight"><pre><code class="java"><span class="n">client</span><span class="o">.</span><span class="na">getServerServices</span><span class="o">().</span><span class="na">deleteByName</span><span class="o">(</span><span class="n">nameOfServer</span><span class="o">);</span> -</code></pre></div> - +<figure class="highlight"><pre><code class="language-java" data-lang="java"><span class="n">client</span><span class="o">.</span><span class="na">getServerServices</span><span class="o">().</span><span class="na">deleteByName</span><span class="o">(</span><span class="n">nameOfServer</span><span class="o">);</span></code></pre></figure> -<p>To ssh into a third-party image, you may need credentials that aren't default. +<p>To ssh into a third-party image, you may need credentials that arenât default. To find out the proper credentials, start up a server and run:</p> -<div class="highlight"><pre><code class="java"><span class="n">Credentials</span> <span class="n">instanceCredentials</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">getServerServices</span><span class="o">().</span><span class="na">getServerCredentialsList</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="n">nameOfServer</span><span class="o">)</span> -</code></pre></div> - +<figure class="highlight"><pre><code class="language-java" data-lang="java"><span class="nc">Credentials</span> <span class="n">instanceCredentials</span> <span class="o">=</span> <span class="n">client</span><span class="o">.</span><span class="na">getServerServices</span><span class="o">().</span><span class="na">getServerCredentialsList</span><span class="o">().</span><span class="na">get</span><span class="o">(</span><span class="n">nameOfServer</span><span class="o">)</span></code></pre></figure> -<p>Using these credentials, it's possible to use jclouds to log in to the instance:</p> +<p>Using these credentials, itâs possible to use jclouds to log in to the instance:</p> -<div class="highlight"><pre><code class="java"><span class="n">SshClient</span> <span class="n">sshClient</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="na">utils</span><span class="o">().</span><span class="na">sshFactory</span><span class="o">().</span><span class="na">create</span><span class="o">(</span><span class="n">socket</span><span class="o">,</span> +<figure class="highlight"><pre><code class="language-java" data-lang="java"><span class="nc">SshClient</span> <span class="n">sshClient</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="na">utils</span><span class="o">().</span><span class="na">sshFactory</span><span class="o">().</span><span class="na">create</span><span class="o">(</span><span class="n">socket</span><span class="o">,</span> <span class="n">instanceCredentials</span><span class="o">.</span><span class="na">account</span><span class="o">,</span> <span class="n">instanceCredentials</span><span class="o">.</span><span class="na">key</span><span class="o">);</span> <span class="n">sshClient</span><span class="o">.</span><span class="na">connect</span><span class="o">();</span> -<span class="n">String</span> <span class="n">output</span> <span class="o">=</span> <span class="n">sshClient</span><span class="o">.</span><span class="na">exec</span><span class="o">(</span><span class="s">"df"</span><span class="o">).</span><span class="na">getOutput</span><span class="o">();</span> -<span class="n">sshClient</span><span class="o">.</span><span class="na">disconnect</span><span class="o">();</span> -</code></pre></div> +<span class="nc">String</span> <span class="n">output</span> <span class="o">=</span> <span class="n">sshClient</span><span class="o">.</span><span class="na">exec</span><span class="o">(</span><span class="s">"df"</span><span class="o">).</span><span class="na">getOutput</span><span class="o">();</span> +<span class="n">sshClient</span><span class="o">.</span><span class="na">disconnect</span><span class="o">();</span></code></pre></figure> - -<h3>Using ComputeService abstraction</h3> +<h3 id="using-computeservice-abstraction">Using ComputeService abstraction</h3> <p>To create a generic context, use (as in the previous section):</p> -<div class="highlight"><pre><code class="java"><span class="n">ComputeServiceContext</span> <span class="n">context</span> <span class="o">=</span> <span class="n">ContextBuilder</span><span class="o">.</span><span class="na">newBuilder</span><span class="o">(</span><span class="s">"gogrid"</span><span class="o">)</span> +<figure class="highlight"><pre><code class="language-java" data-lang="java"><span class="nc">ComputeServiceContext</span> <span class="n">context</span> <span class="o">=</span> <span class="nc">ContextBuilder</span><span class="o">.</span><span class="na">newBuilder</span><span class="o">(</span><span class="s">"gogrid"</span><span class="o">)</span> <span class="o">.</span><span class="na">credentials</span><span class="o">(</span><span class="n">key</span><span class="o">,</span> <span class="n">sharedSecret</span><span class="o">)</span> - <span class="o">.</span><span class="na">modules</span><span class="o">(</span><span class="n">ImmutableSet</span><span class="o">.<</span><span class="n">Module</span><span class="o">></span> <span class="n">of</span><span class="o">(</span><span class="k">new</span> <span class="n">Log4JLoggingModule</span><span class="o">(),</span> + <span class="o">.</span><span class="na">modules</span><span class="o">(</span><span class="nc">ImmutableSet</span><span class="o">.<</span><span class="nc">Module</span><span class="o">></span> <span class="nf">of</span><span class="o">(</span><span class="k">new</span> <span class="nc">Log4JLoggingModule</span><span class="o">(),</span> <span class="k">new</span> <span class="nf">SshjSshClientModule</span><span class="o">()))</span> - <span class="o">.</span><span class="na">buildView</span><span class="o">(</span><span class="n">ComputeServiceContext</span><span class="o">.</span><span class="na">class</span><span class="o">);</span> - -<span class="n">ComputeService</span> <span class="n">service</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="na">getComputeService</span><span class="o">();</span> -</code></pre></div> + <span class="o">.</span><span class="na">buildView</span><span class="o">(</span><span class="nc">ComputeServiceContext</span><span class="o">.</span><span class="na">class</span><span class="o">);</span> +<span class="nc">ComputeService</span> <span class="n">service</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="na">getComputeService</span><span class="o">();</span></code></pre></figure> <p>With having a ComputeService object in place, you can search for specific type of instance and/or image, and run it:</p> -<div class="highlight"><pre><code class="java"><span class="n">Template</span> <span class="n">t</span> <span class="o">=</span> <span class="n">service</span><span class="o">.</span><span class="na">templateBuilder</span><span class="o">().</span><span class="na">minRam</span><span class="o">(</span><span class="mi">4096</span><span class="o">).</span><span class="na">imageId</span><span class="o">(</span><span class="s">"GSI-6890f8b6-c8fb-4ac1-bc33-2563eb4e29d2"</span><span class="o">).</span><span class="na">build</span><span class="o">();</span> -<span class="n">service</span><span class="o">.</span><span class="na">runNodesInGroup</span><span class="o">(</span><span class="s">"testGroup"</span><span class="o">,</span> <span class="mi">1</span> <span class="cm">/*number of instances*/</span><span class="o">,</span> <span class="n">t</span><span class="o">);</span> -</code></pre></div> - +<figure class="highlight"><pre><code class="language-java" data-lang="java"><span class="nc">Template</span> <span class="n">t</span> <span class="o">=</span> <span class="n">service</span><span class="o">.</span><span class="na">templateBuilder</span><span class="o">().</span><span class="na">minRam</span><span class="o">(</span><span class="mi">4096</span><span class="o">).</span><span class="na">imageId</span><span class="o">(</span><span class="s">"GSI-6890f8b6-c8fb-4ac1-bc33-2563eb4e29d2"</span><span class="o">).</span><span class="na">build</span><span class="o">();</span> +<span class="n">service</span><span class="o">.</span><span class="na">runNodesInGroup</span><span class="o">(</span><span class="s">"testGroup"</span><span class="o">,</span> <span class="mi">1</span> <span class="cm">/*number of instances*/</span><span class="o">,</span> <span class="n">t</span><span class="o">);</span></code></pre></figure> <p>For more information on using this abstraction, refer to the detailed <a href="https://github.com/apache/jclouds/blob/master/providers/gogrid/src/test/java/org/jclouds/gogrid/compute/GoGridComputeServiceLiveTest.java";>test case</a>.</p>
Modified: jclouds/site-content/guides/google/index.html URL: http://svn.apache.org/viewvc/jclouds/site-content/guides/google/index.html?rev=1923693&r1=1923692&r2=1923693&view=diff ============================================================================== --- jclouds/site-content/guides/google/index.html (original) +++ jclouds/site-content/guides/google/index.html Mon Feb 10 07:25:53 2025 @@ -154,58 +154,52 @@ </div> <div id="toc"></div> <div id="content"> - <h2><a id="intro"></a>Introduction</h2> - + <h2 id="introduction"><a id="intro"></a>Introduction</h2> <p>This guide helps you to get started with <a href="https://cloud.google.com/";>Google Cloud Platform</a> development using jclouds.</p> -<p>Currently, <a href="https://developers.google.com/compute/";>Google Compute Engine</a> is covered. This is a <a href="https://jclouds.apache.org/start/compute/";>compute service</a> that allows you to run vitual machines on Google's infrastructure. There is also an implementation of the <a href="https://jclouds.apache.org/start/blobstore/";>blob store</a> abstraction for managing key-value storage.</p> +<p>Currently, <a href="https://developers.google.com/compute/";>Google Compute Engine</a> is covered. This is a <a href="https://jclouds.apache.org/start/compute/";>compute service</a> that allows you to run vitual machines on Googleâs infrastructure. There is also an implementation of the <a href="https://jclouds.apache.org/start/blobstore/";>blob store</a> abstraction for managing key-value storage.</p> <p>Working with the Google Cloud Platform requires a project. If you do not have a project yet, you can sign up via the <a href="https://console.developers.google.com/";>Developer Console</a>. There is a free trial availible <a href="https://cloud.google.com/free-trial/";>here</a>.</p> -<h2><a id="examples"></a>Running examples</h2> - +<h2 id="running-examples"><a id="examples"></a>Running examples</h2> <p>A great starting point for using jclouds on GCE is to run the examples provided on <a href="https://github.com/apache/jclouds-examples";>github</a>.</p> <p>Important Setup</p> <ul> -<li>Create a project on the <a href="https://console.developers.google.com/";>Developer Console</a> (instruction availible <a href="https://developers.google.com/console/help/#creatingdeletingprojects";>here</a>)</li> -<li>Go to the <a href="https://console.developers.google.com/";>Developer Console</a> and choose your project.</li> -<li>Enable the Google Compute Engine API under APIs & auth > APIs</li> -<li>Create a service account under APIs & auth > Credentials > Create new Client ID and download the Json key. This is described more throughly below under Authentication.</li> + <li>Create a project on the <a href="https://console.developers.google.com/";>Developer Console</a> (instruction availible <a href="https://developers.google.com/console/help/#creatingdeletingprojects";>here</a>)</li> + <li>Go to the <a href="https://console.developers.google.com/";>Developer Console</a> and choose your project.</li> + <li>Enable the Google Compute Engine API under APIs & auth > APIs</li> + <li>Create a service account under APIs & auth > Credentials > Create new Client ID and download the Json key. This is described more throughly below under Authentication.</li> </ul> - <p>Once you have completed the setup, checkout the <a href="https://github.com/apache/jclouds-examples";>jclouds-examples</a> repository and look at either <a href="https://github.com/apache/jclouds-examples/tree/master/compute-basics";>compute-basic</a> for an example of using the compute service abstraction or <a href="https://github.com/apache/jclouds-examples/tree/master/google-lb";>google-lb</a> for an example of using the GCE api directly.</p> <p>If you are having trouble feel free to <a href="https://jclouds.apache.org/community/";>reach out</a>.</p> -<h2><a id="auth"></a>Authentication</h2> - +<h2 id="authentication"><a id="auth"></a>Authentication</h2> <p>Google Cloud Platform uses OAuth2 which gives a variety of choices how to authenticate:</p> <ol> -<li>You can ask a user for consent to perform operations in their name.</li> -<li>You can create a service account and authenticate using its private key.</li> -<li>Unless configured otherwise, programs running on a GCE instance can perform operations as the project's default service account (<a href="https://cloud.google.com/compute/docs/authentication";>documentation</a>).</li> + <li>You can ask a user for consent to perform operations in their name.</li> + <li>You can create a service account and authenticate using its private key.</li> + <li>Unless configured otherwise, programs running on a GCE instance can perform operations as the projectâs default service account (<a href="https://cloud.google.com/compute/docs/authentication";>documentation</a>).</li> </ol> - <p>You can find all the details in <a href="https://developers.google.com/accounts/docs/OAuth2";>the documentation</a>, in the jclouds-examples repository we focus on option 2: service accounts.</p> <p>To create a new service account:</p> <ul> -<li>Go to the <a href="https://console.developers.google.com/";>Developer Console</a>.</li> -<li>Choose your project.</li> -<li>Choose API & auth > Credentials.</li> -<li>Click "Create new Client ID".</li> -<li>Select "Service account" and click "Create Client ID".</li> -<li>Details of the new service account will be displayed.</li> -<li>Download a JSON key for a service account by clicking Generate new JSON key. JSON keys are used for authentication when running jclouds on GCE. Make a note of the service account email address - this is the identity that goes with the key.</li> + <li>Go to the <a href="https://console.developers.google.com/";>Developer Console</a>.</li> + <li>Choose your project.</li> + <li>Choose API & auth > Credentials.</li> + <li>Click âCreate new Client IDâ.</li> + <li>Select âService accountâ and click âCreate Client IDâ.</li> + <li>Details of the new service account will be displayed.</li> + <li>Download a JSON key for a service account by clicking Generate new JSON key. JSON keys are used for authentication when running jclouds on GCE. Make a note of the service account email address - this is the identity that goes with the key.</li> </ul> - <p>If you are having trouble feel free to <a href="https://jclouds.apache.org/community/";>reach out</a>.</p> </div> Modified: jclouds/site-content/guides/index.html URL: http://svn.apache.org/viewvc/jclouds/site-content/guides/index.html?rev=1923693&r1=1923692&r2=1923693&view=diff ============================================================================== --- jclouds/site-content/guides/index.html (original) +++ jclouds/site-content/guides/index.html Mon Feb 10 07:25:53 2025 @@ -152,46 +152,42 @@ <p>Use these guides for getting started with any of the cloud providers below:</p> <ul> -<li><a href="aws">Amazon Web Services</a></li> -<li><a href="azure-storage">Azure Storage</a></li> -<li><a href="cloudsigma">CloudSigma</a></li> -<li><a href="dimensiondata">Dimension Data</a></li> -<li><a href="docker">Docker</a></li> -<li><a href="go-grid">GoGrid</a></li> -<li><a href="google">Google Cloud Platform</a></li> -<li><a href="openstack">OpenStack</a></li> -<li><a href="profitbricks">ProfitBricks</a></li> -<li><a href="rackspace">Rackspace</a></li> -<li><a href="softlayer">SoftLayer</a></li> + <li><a href="aws">Amazon Web Services</a></li> + <li><a href="azure-storage">Azure Storage</a></li> + <li><a href="cloudsigma">CloudSigma</a></li> + <li><a href="dimensiondata">Dimension Data</a></li> + <li><a href="docker">Docker</a></li> + <li><a href="go-grid">GoGrid</a></li> + <li><a href="google">Google Cloud Platform</a></li> + <li><a href="openstack">OpenStack</a></li> + <li><a href="profitbricks">ProfitBricks</a></li> + <li><a href="rackspace">Rackspace</a></li> + <li><a href="softlayer">SoftLayer</a></li> </ul> - <p>Use these guides for more in depth usage:</p> <ul> -<li>Amazon Web Services - -<ul> -<li><a href="aws-ebs">Elastic Block Store (EBS)</a></li> -<li><a href="aws-ec2">Elastic Compute Cloud (EC2)</a></li> -<li><a href="glacier">Glacier</a></li> -<li><a href="aws-s3">Simple Storage Service (S3)</a></li> -<li><a href="aws-sqs">Simple Queue Service (SQS)</a></li> + <li>Amazon Web Services + <ul> + <li><a href="aws-ebs">Elastic Block Store (EBS)</a></li> + <li><a href="aws-ec2">Elastic Compute Cloud (EC2)</a></li> + <li><a href="glacier">Glacier</a></li> + <li><a href="aws-s3">Simple Storage Service (S3)</a></li> + <li><a href="aws-sqs">Simple Queue Service (SQS)</a></li> + </ul> + </li> </ul> -</li> -</ul> - <p>Use these guides for getting started with other technologies that jclouds is compatible with:</p> <ul> -<li><a href="chef">Chef</a></li> -<li><a href="filesystem">File System</a></li> -<li><a href="jdbc">JDBC</a></li> -<li><a href="karaf">Karaf</a></li> + <li><a href="chef">Chef</a></li> + <li><a href="filesystem">File System</a></li> + <li><a href="jdbc">JDBC</a></li> + <li><a href="karaf">Karaf</a></li> </ul> - <div class="row clearfix"> <div id="footer" class="col-md-12 column"> <div id="footer"> Modified: jclouds/site-content/guides/jdbc/index.html URL: http://svn.apache.org/viewvc/jclouds/site-content/guides/jdbc/index.html?rev=1923693&r1=1923692&r2=1923693&view=diff ============================================================================== --- jclouds/site-content/guides/jdbc/index.html (original) +++ jclouds/site-content/guides/jdbc/index.html Mon Feb 10 07:25:53 2025 @@ -150,51 +150,47 @@ <h1>JDBC: Getting Started Guide</h1> </div> <ol> -<li>Setup your project to include jdbc - -<ul> -<li>Get the dependency <code>org.apache.jclouds.labs/jdbc</code>.</li> -</ul> -</li> -<li>Start coding</li> + <li>Setup your project to include jdbc + <ul> + <li>Get the dependency <code class="language-plaintext highlighter-rouge">org.apache.jclouds.labs/jdbc</code>.</li> + </ul> + </li> + <li>Start coding</li> </ol> - -<div class="highlight"><pre><code class="java"><span class="c1">// setup the container name used by the provider (like bucket in S3)</span> -<span class="n">String</span> <span class="n">containerName</span> <span class="o">=</span> <span class="s">"test-container"</span><span class="o">;</span> +<figure class="highlight"><pre><code class="language-java" data-lang="java"><span class="c1">// setup the container name used by the provider (like bucket in S3)</span> +<span class="nc">String</span> <span class="n">containerName</span> <span class="o">=</span> <span class="s">"test-container"</span><span class="o">;</span> <span class="c1">// get a context with jdbc that offers the portable BlobStore api. Pass</span> <span class="c1">// the jpa persistence unit name in the modules.</span> -<span class="n">BlobStoreContext</span> <span class="n">context</span> <span class="o">=</span> <span class="n">ContextBuilder</span><span class="o">.</span><span class="na">newBuilder</span><span class="o">(</span><span class="s">"jdbc"</span><span class="o">)</span> - <span class="o">.</span><span class="na">modules</span><span class="o">(</span><span class="n">ImmutableSet</span><span class="o">.<</span><span class="n">Module</span><span class="o">></span> <span class="n">of</span><span class="o">(</span><span class="k">new</span> <span class="n">JpaPersistModule</span><span class="o">(</span><span class="n">jpaModuleName</span><span class="o">)))</span> - <span class="o">.</span><span class="na">build</span><span class="o">(</span><span class="n">BlobStoreContext</span><span class="o">.</span><span class="na">class</span><span class="o">);</span> +<span class="nc">BlobStoreContext</span> <span class="n">context</span> <span class="o">=</span> <span class="nc">ContextBuilder</span><span class="o">.</span><span class="na">newBuilder</span><span class="o">(</span><span class="s">"jdbc"</span><span class="o">)</span> + <span class="o">.</span><span class="na">modules</span><span class="o">(</span><span class="nc">ImmutableSet</span><span class="o">.<</span><span class="nc">Module</span><span class="o">></span> <span class="nf">of</span><span class="o">(</span><span class="k">new</span> <span class="nc">JpaPersistModule</span><span class="o">(</span><span class="n">jpaModuleName</span><span class="o">)))</span> + <span class="o">.</span><span class="na">build</span><span class="o">(</span><span class="nc">BlobStoreContext</span><span class="o">.</span><span class="na">class</span><span class="o">);</span> <span class="c1">// create a container in the default location</span> -<span class="n">BlobStore</span> <span class="n">blobStore</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="na">getBlobStore</span><span class="o">();</span> +<span class="nc">BlobStore</span> <span class="n">blobStore</span> <span class="o">=</span> <span class="n">context</span><span class="o">.</span><span class="na">getBlobStore</span><span class="o">();</span> <span class="n">blobStore</span><span class="o">.</span><span class="na">createContainerInLocation</span><span class="o">(</span><span class="kc">null</span><span class="o">,</span> <span class="n">containerName</span><span class="o">);</span> <span class="c1">// add blob</span> -<span class="n">Blob</span> <span class="n">blob</span> <span class="o">=</span> <span class="n">blobStore</span><span class="o">.</span><span class="na">newBlob</span><span class="o">(</span><span class="s">"test"</span><span class="o">);</span> -<span class="n">blob</span><span class="o">.</span><span class="na">setPayload</span><span class="o">(</span><span class="s">"test data"</span><span class="o">);</span> +<span class="nc">Blob</span> <span class="n">blob</span> <span class="o">=</span> <span class="n">blobStore</span><span class="o">.</span><span class="na">newBlob</span><span class="o">(</span><span class="s">"test"</span><span class="o">);</span> +<span class="n">blob</span><span class="o">.</span><span class="na">setPayload</span><span class="o">(</span><span class="s">"test data"</span><span class="o">);</span> <span class="n">blobStore</span><span class="o">.</span><span class="na">putBlob</span><span class="o">(</span><span class="n">containerName</span><span class="o">,</span> <span class="n">blob</span><span class="o">);</span> <span class="c1">// retrieve blob</span> -<span class="n">Blob</span> <span class="n">blobRetrieved</span> <span class="o">=</span> <span class="n">blobStore</span><span class="o">.</span><span class="na">getBlob</span><span class="o">(</span><span class="n">containerName</span><span class="o">,</span> <span class="s">"test"</span><span class="o">);</span> +<span class="nc">Blob</span> <span class="n">blobRetrieved</span> <span class="o">=</span> <span class="n">blobStore</span><span class="o">.</span><span class="na">getBlob</span><span class="o">(</span><span class="n">containerName</span><span class="o">,</span> <span class="s">"test"</span><span class="o">);</span> <span class="c1">// delete blob</span> -<span class="n">blobStore</span><span class="o">.</span><span class="na">removeBlob</span><span class="o">(</span><span class="n">containerName</span><span class="o">,</span> <span class="s">"test"</span><span class="o">);</span> +<span class="n">blobStore</span><span class="o">.</span><span class="na">removeBlob</span><span class="o">(</span><span class="n">containerName</span><span class="o">,</span> <span class="s">"test"</span><span class="o">);</span> <span class="c1">//close context</span> -<span class="n">context</span><span class="o">.</span><span class="na">close</span><span class="o">();</span> -</code></pre></div> - +<span class="n">context</span><span class="o">.</span><span class="na">close</span><span class="o">();</span></code></pre></figure> -<h3>Configuring the persistence unit in persistence.xml</h3> +<h3 id="configuring-the-persistence-unit-in-persistencexml">Configuring the persistence unit in persistence.xml</h3> -<p>The JDBC Blobstore uses the standard jpa configuration file <code>persistence.xml</code>. It must be placed -in <code>resources/META-INF</code>. Here is an example of <code>persistence.xml</code>:</p> +<p>The JDBC Blobstore uses the standard jpa configuration file <code class="language-plaintext highlighter-rouge">persistence.xml</code>. It must be placed +in <code class="language-plaintext highlighter-rouge">resources/META-INF</code>. Here is an example of <code class="language-plaintext highlighter-rouge">persistence.xml</code>:</p> -<pre><code><?xml version="1.0" encoding="UTF-8" ?> +<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code><?xml version="1.0" encoding="UTF-8" ?> <persistence xmlns="http://java.sun.com/xml/ns/persistence"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://java.sun.com/xml/ns/persistence http://java.sun.com/xml/ns/persistence/persistence_1_0.xsd"; @@ -219,15 +215,14 @@ in <code>resources/META-INF</code>. Here </properties> </persistence-unit> </persistence> -</code></pre> +</code></pre></div></div> <ul> -<li>The persistence configuration depends on the database.</li> -<li>You must provide an object mapper. The persistence configuration also depends on the object mapper + <li>The persistence configuration depends on the database.</li> + <li>You must provide an object mapper. The persistence configuration also depends on the object mapper used.</li> </ul> - <div class="row clearfix"> <div id="footer" class="col-md-12 column"> <div id="footer"> Modified: jclouds/site-content/guides/karaf/index.html URL: http://svn.apache.org/viewvc/jclouds/site-content/guides/karaf/index.html?rev=1923693&r1=1923692&r2=1923693&view=diff ============================================================================== --- jclouds/site-content/guides/karaf/index.html (original) +++ jclouds/site-content/guides/karaf/index.html Mon Feb 10 07:25:53 2025 @@ -149,116 +149,103 @@ <div class="page-header"> <h1>Apache Karaf: Getting Started Guide</h1> </div> - <h2>Introduction</h2> + <h2 id="introduction">Introduction</h2> <p><a href="https://karaf.apache.org";>Apache Karaf</a> is an OSGi runtime that runs on top of most OSGi containers like <a href="https://felix.apache.org";>Apache Felix</a> and -<a href="https://www.eclipse.org/equinox/";>Eclipse Equinox</a>. jclouds provides easy integration with Apache Karaf by leveraging the Karaf <em>"Feature"</em> concept.</p> +<a href="https://www.eclipse.org/equinox/";>Eclipse Equinox</a>. jclouds provides easy integration with Apache Karaf by leveraging the Karaf <em>âFeatureâ</em> concept.</p> <p>This section will describe how to install jclouds on Apache Karaf and run some examples that demonstrate the power of jclouds in a dynamic environment such as Karaf.</p> -<p>jclouds provides the following Karaf "features":</p> +<p>jclouds provides the following Karaf âfeaturesâ:</p> <ul> -<li>jclouds-api-byon</li> -<li>jclouds-api-chef</li> -<li>jclouds-api-cloudstack</li> -<li>jclouds-api-ec2</li> -<li>jclouds-api-openstack-cinder</li> -<li>jclouds-api-openstack-keystone</li> -<li>jclouds-api-openstack-nova</li> -<li>jclouds-api-rackspace-clouddns</li> -<li>jclouds-api-rackspace-cloudidentity</li> -<li>jclouds-api-route53</li> -<li>jclouds-api-s3</li> -<li>jclouds-api-sqs</li> -<li>jclouds-api-sts</li> -<li>jclouds-api-swift</li> -<li>jclouds-aws-cloudwatch</li> -<li>jclouds-aws-ec2</li> -<li>jclouds-aws-route53</li> -<li>jclouds-aws-s3</li> -<li>jclouds-aws-sqs</li> -<li>jclouds-aws-sts</li> -<li>jclouds-azureblob</li> -<li>jclouds-chef</li> -<li>jclouds-cloudfiles-uk</li> -<li>jclouds-cloudfiles-us</li> -<li>jclouds-digitalocean</li> -<li>jclouds-dynect</li> -<li>jclouds-elastichosts-lax-p</li> -<li>jclouds-elastichosts-lon-b</li> -<li>jclouds-elastichosts-lon-p</li> -<li>jclouds-elastichosts-sat-p</li> -<li>jclouds-elastichosts-tor-p</li> -<li>jclouds-glesys</li> -<li>jclouds-go2cloud-jhb1</li> -<li>jclouds-gogrid</li> -<li>jclouds-hpcloud-compute</li> -<li>jclouds-hpcloud-objectstorage</li> -<li>jclouds-openhosting-east1</li> -<li>jclouds-rackspace-cloudblockstorage-uk</li> -<li>jclouds-rackspace-cloudblockstorage-us</li> -<li>jclouds-rackspace-clouddns-uk</li> -<li>jclouds-rackspace-clouddns-us</li> -<li>jclouds-rackspace-cloudfiles-uk</li> -<li>jclouds-rackspace-cloudfiles-us</li> -<li>jclouds-rackspace-cloudloadbalancers-uk</li> -<li>jclouds-rackspace-cloudloadbalancers-us</li> -<li>jclouds-rackspace-cloudservers-uk</li> -<li>jclouds-rackspace-cloudservers-us</li> -<li>jclouds-serverlove-z1-man</li> -<li>jclouds-skalicloud-sdg-my</li> -<li>jclouds-softlayer</li> + <li>jclouds-api-byon</li> + <li>jclouds-api-chef</li> + <li>jclouds-api-cloudstack</li> + <li>jclouds-api-ec2</li> + <li>jclouds-api-openstack-cinder</li> + <li>jclouds-api-openstack-keystone</li> + <li>jclouds-api-openstack-nova</li> + <li>jclouds-api-rackspace-clouddns</li> + <li>jclouds-api-rackspace-cloudidentity</li> + <li>jclouds-api-route53</li> + <li>jclouds-api-s3</li> + <li>jclouds-api-sqs</li> + <li>jclouds-api-sts</li> + <li>jclouds-api-swift</li> + <li>jclouds-aws-cloudwatch</li> + <li>jclouds-aws-ec2</li> + <li>jclouds-aws-route53</li> + <li>jclouds-aws-s3</li> + <li>jclouds-aws-sqs</li> + <li>jclouds-aws-sts</li> + <li>jclouds-azureblob</li> + <li>jclouds-chef</li> + <li>jclouds-cloudfiles-uk</li> + <li>jclouds-cloudfiles-us</li> + <li>jclouds-digitalocean</li> + <li>jclouds-dynect</li> + <li>jclouds-elastichosts-lax-p</li> + <li>jclouds-elastichosts-lon-b</li> + <li>jclouds-elastichosts-lon-p</li> + <li>jclouds-elastichosts-sat-p</li> + <li>jclouds-elastichosts-tor-p</li> + <li>jclouds-glesys</li> + <li>jclouds-go2cloud-jhb1</li> + <li>jclouds-gogrid</li> + <li>jclouds-hpcloud-compute</li> + <li>jclouds-hpcloud-objectstorage</li> + <li>jclouds-openhosting-east1</li> + <li>jclouds-rackspace-cloudblockstorage-uk</li> + <li>jclouds-rackspace-cloudblockstorage-us</li> + <li>jclouds-rackspace-clouddns-uk</li> + <li>jclouds-rackspace-clouddns-us</li> + <li>jclouds-rackspace-cloudfiles-uk</li> + <li>jclouds-rackspace-cloudfiles-us</li> + <li>jclouds-rackspace-cloudloadbalancers-uk</li> + <li>jclouds-rackspace-cloudloadbalancers-us</li> + <li>jclouds-rackspace-cloudservers-uk</li> + <li>jclouds-rackspace-cloudservers-us</li> + <li>jclouds-serverlove-z1-man</li> + <li>jclouds-skalicloud-sdg-my</li> + <li>jclouds-softlayer</li> </ul> - -<h2>Installation</h2> +<h2 id="installation">Installation</h2> <ol> -<li>Get jclouds-karaf from the <a href="https://github.com/apache/jclouds-karaf";>jclouds-karaf repository</a> on GitHub.</li> + <li>Get jclouds-karaf from the <a href="https://github.com/apache/jclouds-karaf";>jclouds-karaf repository</a> on GitHub.</li> </ol> - <p>As of the jclouds Version 1.0.0 release, the jclouds-karaf feature is available on the central maven repository, so you can skip this step of getting the source and building it and go directly to the install of the jclouds feature.</p> -<div class="highlight"><pre><code class="sh">git clone git://github.com/apache/jclouds-karaf.git +<figure class="highlight"><pre><code class="language-sh" data-lang="sh">git clone git://github.com/apache/jclouds-karaf.git <span class="nb">cd </span>jclouds-karaf -mvn clean install -</code></pre></div> - +mvn clean <span class="nb">install</span></code></pre></figure> <ol> -<li>Start Karaf and install the jclouds feature.</li> + <li>Start Karaf and install the jclouds feature.</li> </ol> - -<div class="highlight"><pre><code class="text">features:addurl mvn:org.jclouds.karaf/feature/1.0/xml/features -features:install jclouds -</code></pre></div> - +<figure class="highlight"><pre><code class="language-text" data-lang="text">features:addurl mvn:org.jclouds.karaf/feature/1.0/xml/features +features:install jclouds</code></pre></figure> <ol> -<li>Now that the core of jclouds is installed, select any additional jclouds features you wish and install them using the shell:</li> + <li>Now that the core of jclouds is installed, select any additional jclouds features you wish and install them using the shell:</li> </ol> +<figure class="highlight"><pre><code class="language-text" data-lang="text">features:list | grep jclouds</code></pre></figure> -<div class="highlight"><pre><code class="text">features:list | grep jclouds -</code></pre></div> - - -<p><em><em>Example</em></em></p> +<p><em>*Example*</em></p> <ol> -<li>For installing the module for aws-s3:</li> + <li>For installing the module for aws-s3:</li> </ol> +<figure class="highlight"><pre><code class="language-text" data-lang="text">features:install jclouds-aws-s3</code></pre></figure> -<div class="highlight"><pre><code class="text">features:install jclouds-aws-s3 -</code></pre></div> - - -<h2>Running the examples</h2> +<h2 id="running-the-examples">Running the examples</h2> <p>The following example demonstrates how using jclouds inside Karaf can make it easy to use jclouds. The example leverages the Karaf shell and the configuration administrator to provide two shell commands that read and write data to a blobstore. The BlobStore provider and the access information @@ -266,45 +253,36 @@ can change dynamically, and they may be <p>The first step is to get and build the example:</p> -<div class="highlight"><pre><code class="text">git clone https://[email protected]/apache/jclouds-examples.git +<figure class="highlight"><pre><code class="language-text" data-lang="text">git clone https://[email protected]/apache/jclouds-examples.git cd jclouds-examples/blobstore-karaf-shell -mvn clean install -</code></pre></div> - +mvn clean install</code></pre></figure> <p>Then from Karaf shell you can install the example:</p> -<div class="highlight"><pre><code class="text">osgi:install -s mvn:org.jclouds.examples/blobstore-karaf-shell/1.0-SNAPSHOT -</code></pre></div> - +<figure class="highlight"><pre><code class="language-text" data-lang="text">osgi:install -s mvn:org.jclouds.examples/blobstore-karaf-shell/1.0-SNAPSHOT</code></pre></figure> <p>The command above installs in Karaf two new commands:</p> <ul> -<li>jclouds:blobstore-write</li> -<li>jclouds:blobstore-read</li> + <li>jclouds:blobstore-write</li> + <li>jclouds:blobstore-read</li> </ul> - <p>In order to use those commands, you first need to configure the provider. The configuration is done using the org.jclouds.blobstore PID. You can create the configuration either from inside the shell or -by dropping a file named org.jclouds.blobstore.cfg under karaf's etc folder. -Let's see how it can be done using the Karaf shell:</p> +by dropping a file named org.jclouds.blobstore.cfg under karafâs etc folder. +Letâs see how it can be done using the Karaf shell:</p> -<div class="highlight"><pre><code class="text">config:edit org.jclouds.blobstore +<figure class="highlight"><pre><code class="language-text" data-lang="text">config:edit org.jclouds.blobstore config:propset provider aws-s3 config:propset accessKeyId XXXXXX config:propset secretKey XXXXXX -config:update -</code></pre></div> - +config:update</code></pre></figure> <p>Now you are ready to use the commands</p> -<div class="highlight"><pre><code class="text">jclouds:blobstore-write mybucket myblob JCloudsRocks -jclouds:blobstore-write mybucket myblob -</code></pre></div> - +<figure class="highlight"><pre><code class="language-text" data-lang="text">jclouds:blobstore-write mybucket myblob JCloudsRocks +jclouds:blobstore-write mybucket myblob</code></pre></figure> <p>At any point in time, you can edit the configuration, either using the shell or by editing the configuration file. The commands will pick up the changes immediately. @@ -312,6 +290,7 @@ This way you can even switch providers.< <p>Watch the <a href="https://www.youtube.com/watch?v=SIvSaGEKrkM";>demo video</a>.</p> + <div class="row clearfix"> <div id="footer" class="col-md-12 column"> <div id="footer">
