Synnefo

{% extends "im/account_base.html" %}

{% load filters %}

{% block headjs %}

        {{ block.super }}         

    <script>

      var CHANGE_TOKEN_URL = '{% url update_token %}';

    </script>        

{% endblock %}        

{% block page.body %}

<form>{% csrf_token %}</form>

<div class="api-access-view">

    <div>

    {% block page.body.title %}

        <h2>API details</h2>

    {% endblock %}

        <p class="dotted">

    To use {{ BRANDING_SERVICE_NAME }} via its REST API you will need the following Authentication URL

    and Token:<br /><br />

        </p>

    </div>

    <div class="subsection dotted">

    {% block page.body.token %}

        <div class="token-view">

            <div class="detail small clearfix"> 

                <span class="title">Authentication URL</span>

                <span id="dummy_token_url" class="dummy-input">&nbsp;</span>

                <input value="{{ token_url }}" type="text" name="token_url" disabled 

            </div

            <div ="detail ">

                <div class="facts clearfix">

                    <span class="title">Token</span>

                    <span id="dummy_auth_token" class="dummy-input">&nbsp;</span>

                    <input value="{{ request.user.auth_token }}" type="text" name="auth_token" disabled

                    <span ="expires">

                        <span class="date">

                            expires in {{ user.auth_token_expires|timeuntil }}

                            ({{ user.auth_token_expires|date }})

                        </span>

                    </span>

                </div>

                <div class="actions">

                    <div class="renew-token">

                        <span class="wrap">

                            <a href="#" class="do">renew token</a>

                            <a href="#" class="confirm">confirm</a>

                            <a href="#" class="close">x</a>

                        </span>

                        <p class="sub"><span>Every time you renew it, make sure to

                update the clients you use with the new token.</span></p>

                    </div>

                </div>

                <span class="extra-img" id="token-span">&nbsp;</span>

            </div>

        </div>

        {% endblock %}

    </div>

   <div class="subsection">

    {% block page.body.description %}

        <div class="two-cols dotted clearfix">

            <div class="rt">

                {% block page.body.api_advanced %}

                <h2>API advanced usage</h2>

                <p>

                Apart from using the kamaki command line client, you can also import the

                kamaki library inside your code and use it directly. More details on how

                to do that on the corresponding  

                <a href="http://www.synnefo.org/docs/kamaki/latest/index.html">kamaki </a>page.</p> 

                <p>You can also implement the REST API calls by yourself, without

                using the official kamaki library if you feel confident with your

                programming skills. To do so, you first need to get a good grasp of the

                API itself; for more information take a look at the corresponding page

                inside the 

                <a href="http://www.synnefo.org/docs">Synnefo documentation</a>.

                </p>

                {% endblock %}

            </div>

            <div class="lt">

                <h2>General</h2>

                <p>{{ BRANDING_SERVICE_NAME }} provides a complete REST API that allows you to access and

    control your virtual resources programmatically. This means you can execute

    all the actions you do from the {{ BRANDING_SERVICE_NAME }} Web UI by using a command

    line client or importing the corresponding library inside your own code.</p>

    <p>

                If

                you want to learn more about the specification of the REST API itself,

                please take a look at the <a href="http://www.synnefo.org/docs" 

                alt="Synnefo documentation">Synnefo documentation</a>. 

                </p>

            </div>

        </div>

    {% endblock %}

    </div>

    <div class="two-cols dotted clearfix">

        <div class="rt">

           <h2>Other clients</h2>

           <p>If you are using a client different from kamaki that supports the OpenStack

APIs and needs a username/password combination to operate, please use

the following:</p>

<p>username:  <span class="user-data">{{ user.uuid }}</span>

password:  <span class="user-data">{{ user.auth_token }}</span></p>

<p>The username is your  {{ BRANDING_SERVICE_NAME }} user ID (UUID) and the password

is your Token. As you can see, its the same shown in the

previous section. </p>

        </div>

        <div class="lt">

            {% block page.body.clients %}

            <h2>Kamaki</h2>

            <p><a href="{{ client_url }}" alt="kamaki">Kamaki</a> is the official

    {{ BRANDING_SERVICE_NAME }} command line client. You can use it to control your virtual

    resources from the command line or use it inside your scripts.</p>

            <p>Kamaki allows you to execute all the operations you do from the Web UI. You can use kamaki to<br><br>

            - register images,<br>- spawn clusters of customized VMs,<br>- connect them to

    Private Virtual Networks,<br>- have them executing computations dynamically<br> <br>and

    many other neat things.</p>

            <p> Kamaki is available for most Linux distributions,

    Windows and Mac OS X. To use it you will need to set it up using your

    Token and the Authentication URL, found above. To

    learn more about kamaki and how to install, configure and use, take a look

    at its <a href="http://www.synnefo.org/docs/kamaki/latest/index.html">corresponding page</a>.

            </p>

             <p class="download">You can download kamaki 

    from the <a href="http://www.synnefo.org/docs/kamaki/latest/index.html">project homepage</a>.</p>

             <p>If you are using kamaki, you can download a pre-configured .kamakirc

file that contains your Authentication URL and Token. Store this file

under your home directory (~/.kamakirc) and kamaki will be able to

access  {{ BRANDING_SERVICE_NAME }} automatically without the need of extra

manual configuration.</p>

<a href="{% url api_access_config %}" class="submit">Download your .kamakirc</a> 

        </div>

        {% endblock %}

    </div>

</div>

{% endblock %}