index.html

---
layout: index
title: Fluent OpenStack client for Java
---

<div class="mainheader-pre">
    <div class="jumbotron mainheader">
        <div class="container">
            <div class="row">
                <div class="col-md-5">
                    <h1>OpenStack4j</h1>
                    <p style="font-weight:200; color: #eee; margin-left:40px;">Fluent OpenStack SDK for Java</p>
                </div>
                <div class="col-md-6" style="margin-top:30px;">
		<span style="margin-left:30px;">
          <a href="/learn" class="btn btn-default btn-success btn-lg"><span class="glyphicon glyphicon-book"> </span>
              Docs</a>
          <a href="/javadoc/" class="btn btn-default btn-info btn-lg" target="_blank"><span
                  class="glyphicon glyphicon-info-sign"> </span> JavaDoc</a>
          <a href="/learn/getting-started" class="btn btn-warning btn-lg"><span
                  class="glyphicon glyphicon-save"> </span> Install</a>
            </span>
                </div>
            </div>
        </div>
    </div>
    <div class="header-bottom"></div>
</div>

<!-- Clouds we Support -->
<div class="container">
    <div class="row-fluid style=" margin: -40px 0px 10px 0px;
    "">
    <div class="section-divider">
        <span class="text">Public/Private OpenStack Cloud Support</span>
    </div>
</div>
<div class="row-fluid">
    <div class="span12">
        <ul class="cloud-inline">
            <li><img src="/assets/img/openstack.png" alt="OpenStack" title="OpenStack" class="cloud-img"></li>
            <li><h5><b>Hosted and sponsored by:</b></h5><img src="/assets/img/rackspace.png" alt="Rackspace"
                                                             title="Rackspace" class="cloud-img"></li>
        </ul>
    </div>
</div>
</div>

<!-- Info -->

<div class="row-fluid">
    <div class="container">
        <div class="section-divider">
            <span class="text">Take Control of Your Cloud</span>
        </div>
    </div>
</div>
<div class="row-fluid">
    <div class="container about-section">
        <div class="row-fluid">
		<span class="span12">
		OpenStack4j is an open source OpenStack client which allows provisioning and control of an OpenStack system. The library and has been broken out into several major API abstractions:
		<br><br>
		</span>
        </div>
        <div class="slideshow">
            <div class="span4 multi-items">
                <div class="imageLabel"><span class="glyphicon glyphicon-lock"></span> Identity V2</div>
                <p>The Identity (Keystone) V2 service provides the central directory of users, tenants, service
                    endpoints
                    and authorization. </p>
                <p><a href="/learn/identity/identity-v2" class="btn btn-xs btn-inverse"><span
                        class="glyphicon glyphicon-book"> </span> Identity V2 Guide</a></p>
            </div>
            <div class="span4 multi-items">
                <div class="imageLabel"><span class="glyphicon glyphicon-lock"></span> Identity V3</div>
                <p>The Identity (Keystone) V3 service provides the central directory of users, groups, regions, service,
                    endpoints, role management and authorization. </p>
                <p><a href="/learn/identity/identity-v3" class="btn btn-xs btn-inverse"><span
                        class="glyphicon glyphicon-book"> </span> Identity V3 Guide</a></p>
            </div>
            <div class="span4 multi-items">
                <div class="imageLabel"><span class="glyphicon glyphicon-cog"></span> Compute</div>
                <p>The Compute (Nova) service provides management to Servers (running virtual machines), VM Management,
                    Flavors and diagnostics. The API makes day to day management tasks breeze.</p>
                <p><a href="/learn/compute" class="btn btn-xs btn-inverse"><span
                        class="glyphicon glyphicon-book"> </span> Compute Guide</a></p>

            </div>
            <div class="span4 multi-items">
                <div class="imageLabel"><span class="glyphicon glyphicon-cloud-upload"></span> Image</div>
                <p>The Image (Glance) service provides discovery, registration and delivery services for disk and server
                    images. Stored images can be used as a template for quickly booting new instances.</p>
                <p><a href="/learn/image" class="btn btn-xs btn-inverse"><span class="glyphicon glyphicon-book"> </span>
                    Image Guide</a></p>

            </div>
            <div class="span4 multi-items">
                <div class="imageLabel"><span class="glyphicon glyphicon-signal"></span> Network</div>
                <p>The Network (Neutron) service provides "network connectivity as a service". The OpenStack4j
                    implementation supports Routers, Ports, Subnets and Interface management.</p>
                <p><a href="/learn/network" class="btn btn-xs btn-inverse"><span
                        class="glyphicon glyphicon-book"> </span> Network Guide</a></p>
            </div>
            <div class="span4 multi-items">
                <div class="imageLabel"><span class="glyphicon glyphicon-hdd"></span> Block Storage</div>
                <p>Block Storage (Cinder) Service is a block-level storage solution that enables you to mount drives to
                    scale storage. OpenStack4j implementation fully supports all major operations.</p>
                <p><a href="/learn/blockstorage" class="btn btn-xs btn-inverse"><span
                        class="glyphicon glyphicon-book"> </span> Block Storage Guide</a></p>
            </div>
            <div class="span4 multi-items">
                <div class="imageLabel"><span class="glyphicon glyphicon-save"></span> Object Storage</div>
                <p>Object Storage (Swift) provides online object storage for files and media which can be shared
                    globally or kept private for adhoc storage.
                <p><a href="/learn/objectstorage" class="btn btn-xs btn-inverse"><span
                        class="glyphicon glyphicon-book"> </span> Object Storage Guide</a></p>
            </div>

            <div class="span4 multi-items">
                <div class="imageLabel"><span class="glyphicon glyphicon-stats"></span> Telemetry</div>
                <p>Telemetry (Ceilometer) delivers metering and statistic measurements against OpenStack core
                    components. This is ideal for customer billing, account and reporting of resources.</p>
                <p><a href="/learn/blockstorage" class="btn btn-xs btn-inverse"><span
                        class="glyphicon glyphicon-book"> </span> Block Storage Guide</a></p>
            </div>
            <div class="span4 multi-items">
                <div class="imageLabel"><span class="glyphicon glyphicon-align-justify"></span> Orchestration</div>
                <p>Orchestration (Heat) is a service that you can use to orchestrate multiple composite cloud
                    applications. Using OpenStack4j you can control Stacks, Templates, Resources and Events.</p>
                <p><a href="/learn/orchestration" class="btn btn-xs btn-inverse"><span
                        class="glyphicon glyphicon-book"> </span> Orchestration Guide</a></p>
            </div>
            <div class="span4 multi-items">
                <div class="imageLabel"><span class="glyphicon glyphicon-align-justify"></span> DNS</div>
                <p>DNS (Designate) is a multi-tenant DNSaaS service for OpenStack. Using OpenStack4j you can control Zones and Recordsets.</p>
                <p><a href="/learn/dns-v2" class="btn btn-xs btn-inverse"><span
                        class="glyphicon glyphicon-book"> </span> DNS Guide</a></p>
            </div>
        </div>
    </div>
</div>


<!-- Our users -->

<div class="container">
    <div class="row-fluid">
        <div class="section-divider">
            <span class="text">Growing User Community</span>
        </div>
    </div>
    <div class="row-fluid">
        <div class="span12">
            <ul class="cloud-inline">
                <li><img src="/assets/img/gslab.png" alt="Great Software Lab" title="GS Lab" class="cloud-img">
                </li>
                <li><img src="/assets/img/ibm.png" alt="IBM Research Labs" title="IBM Research Labs" class="cloud-img">
                </li>
                <li><img src="/assets/img/dorado.jpg" alt="Dorado Software" title="Dorado Software" class="cloud-img">
                </li>
                <li><img src="/assets/img/oracle.png" alt="Oracle" title="Oracle" class="cloud-img"></li>
                <li><img src="/assets/img/Samsung.jpg" alt="Samsung" title="Samsung" class="cloud-img"></li>
                <li><img src="/assets/img/sap.png" alt="SAP" title="SAP" class="cloud-img"></li>
            </ul>
            <ul class="cloud-inline">
                <li><h3>And More!</h3></li>
            </ul>
        </div>
    </div>
</div>

<!-- Code Examples -->

<div class="container">
    <div class="row-fluid">
        <div class="section-divider">
            <span class="text">100% Fluent API</span>
        </div>
    </div>
    <div class="row">
        <div class="col-md-6">

            <div class="panel panel-primary">
                <div class="panel-heading"><span class="glyphicon glyphicon-lock"/><strong>Identity</strong></span>
                </div>

                <div class="panel-body">
			<pre class=".prettyprint .lang-java">
// V2 authentication
OSClientV2 os = OSFactory.builderV2()
                  .endpoint("http://127.0.0.1:5000/v2.0")
                  .credentials("admin","secret")
                  .tenantName("admin")
                  .authenticate();

// V3 authentication
OSClientV3 os = OSFactory.builderV3()
                  .endpoint("http://127.0.0.1:5000/v3")
                  .credentials("admin", "secret", Identifier.byName("Default"))
                  .scopeToProject(Identifier.byName("admin"))
                  .authenticate();
			</pre>
                </div>
            </div>
        </div>
        <div class="col-md-6">
            <div class="panel panel-primary">
                <div class="panel-heading"><span class="glyphicon glyphicon-cog"/><strong>Compute</strong></span>
                </div>
                <div class="panel-body">
			<pre class=".prettyprint .lang-java">
// Create a Server Model Object
Server server = Builders.server()
                        .name("Ubuntu 2")
                        .flavor("large")
                        .image("imageId")
                        .build();

// Boot the Server
Server server = os.compute().servers().boot(server);

// Create a Snapshot
os.compute().servers().createSnapshot("id", "name");
			</pre>
                </div>
            </div>
        </div>
    </div>
    <div class="row">
        <div class="col-md-6">

            <div class="panel panel-primary">
                <div class="panel-heading"><span
                        class="glyphicon glyphicon-cloud-upload"/><strong>Image</strong></span>
                </div>

                <div class="panel-body">
			<pre class=".prettyprint .lang-java">
// Create an Image
Image image = os.images().create(Builders.image()
                .name("Cirros 0.3.0 x64")
                .isPublic(true)
                .containerFormat(ContainerFormat.BARE)
                .diskFormat(DiskFormat.QCOW2)
                .build()
                ), Payloads.create(new File("cirros.img")));
			</pre>
                </div>
            </div>
        </div>
        <div class="col-md-6">
            <div class="panel panel-primary">
                <div class="panel-heading"><span class="glyphicon glyphicon-signal"/><strong>Network</strong></span>
                </div>

                <div class="panel-body">
			<pre class=".prettyprint .lang-java">
// Create a Port
Port port = os.networking().port()
              .create(Builders.port()
              .name("port1")
              .networkId("networkId")
              .fixedIp("52.51.1.253", "subnetId")
              .build());
			</pre>
                </div>
            </div>
        </div>
    </div>