brooklyn-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From henev...@apache.org
Subject [10/44] incubator-brooklyn git commit: moving docs/guide files around and menuing
Date Fri, 09 Jan 2015 15:34:39 GMT
http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/guide/yaml/defining-applications/examples.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/defining-applications/examples.md b/docs/guide/yaml/defining-applications/examples.md
new file mode 100644
index 0000000..330b6d3
--- /dev/null
+++ b/docs/guide/yaml/defining-applications/examples.md
@@ -0,0 +1,121 @@
+---
+title: Examples
+layout: guide-normal
+toc: ../guide_toc.json
+categories: [use, guide, defining-applications]
+---
+
+** TODO: this examples page is deprecated;
+code is out-of-date, and better examples are described on the web site.
+need to figure out if this page should be kept at all
+(indeed if the "guide" is even still relevant)**
+
+
+### Integrating with a Maven project
+
+If you have a Maven-based project, integrate this XML fragment with your pom.xml:
+
+<!-- TODO this should import from the downloads page -->
+
+{% highlight xml %}
+<dependencies>
+	<dependency>
+		<groupId>io.brooklyn</groupId>
+		<artifactId>brooklyn-all</artifactId>
+		<version>0.7.0-SNAPSHOT</version>  <!-- BROOKLYN_VERSION -->
+	</dependency>
+</dependencies>
+ 
+<repository>
+    <id>cloudsoft-releases</id>
+    <url>http://developers.cloudsoftcorp.com/download/maven2/</url>
+</repository>
+<repository>
+    <id>libs-snapshot-local</id>
+    <url>http://ccweb.cloudsoftcorp.com/maven/libs-snapshot-local/</url>
+    <snapshots>
+        <enabled>true</enabled>
+        <updatePolicy>never</updatePolicy>
+        <checksumPolicy>fail</checksumPolicy>
+    </snapshots>
+</repository>
+{% endhighlight %}
+
+
+### Starting a Tomcat Server
+
+The code below starts a Tomcat server on the local machine.
+
+The ``main`` method defines the application, and passes it to the ``BrooklynLauncher`` to
be managed. 
+It is then started in a localhost location (other locations are shown in the next section).
+
+The Tomcat's configuration indicates that the given WAR should be deployed to the Tomcat
server when it is started.
+
+{% highlight java %}
+{% readj example_files/tomcat_simple.java %}
+{% endhighlight %}
+
+The ``wars`` config is also supported (with config keys ``ROOT_WAR`` and ``NAMED_WARS`` the
long-hand syntax);
+they accept EARs and other common archives, and can be described as files or as URLs (as
Strings), 
+with URLs supporting an optional ``classpath://org/acme/resources/xxx.war`` syntax.
+
+
+### Starting Tomcat in Amazon EC2
+
+To start a tomcat node or cluster in Amazon EC2, the application is identical to that for
localhost. 
+The only difference is the location supplied.
+
+The Brooklyn CLI can be used to launch the application in your choice of location, such as:
+
+{% highlight bash %}
+brooklyn launch --app TomcatServerApp --location localhost
+brooklyn launch --app TomcatServerApp --location aws-ec2:eu-west-1
+{% endhighlight %}
+
+ 
+### Starting a Tomcat Cluster with Nginx
+
+The code below starts a Tomcat cluster along with an Nginx instance, where each Tomcat server
in the cluster is registered with the Nginx instance.
+
+{% highlight java %}
+{% readj example_files/tomcat_nginx.java %}
+{% endhighlight %}
+
+This creates a cluster that of Tomcat servers, along with an Nginx instance. The ``NginxController``
instance
+is notified whenever a member of the cluster joins or leaves; the entity is configured to
look at the ``HTTP_PORT``
+attribute of that instance so that the Nginx configuration can be updated with the ip:port
of the cluster member.
+
+<!---
+TODO things may need tidying (paragraphs, and/or eliminating any extra setConfig calls, though
looks like these have gone)
+-->
+
+
+Starting a Multi-location Tomcat Fabric
+---------------------------------------
+
+<!---
+TODO this example should use several cloud providers, including Openshift, and use GeoDNS,

+and maybe a data store and/or messaging service; it is the last "most advanced" example
+-->
+
+<!---
+FIXME Discuss above comment with Aled/Alex as it is contentious
+-->
+
+The ``ControlledDynamicWebAppCluster`` entity used above can also be used with a DynamicFabric
to start
+a web-cluster in each location.
+
+{% highlight java %}
+{% readj example_files/tomcat_multi-location.java %}
+{% endhighlight %}
+
+
+Examples Source
+---------------
+
+Source code for (more up-to-date!) examples is available for download from GitHub. To retrieve
the source, execute the following command:
+
+    git clone git@github.com:apache/incubator-brooklyn.git
+    cd incubator-brooklyn/examples
+
+You can also [browse the code](https://github.com/apache/incubator-brooklyn/tree/examples)
on the web.

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/guide/yaml/defining-applications/mysql-in-catalog-w700.png
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/defining-applications/mysql-in-catalog-w700.png b/docs/guide/yaml/defining-applications/mysql-in-catalog-w700.png
new file mode 100644
index 0000000..f370249
Binary files /dev/null and b/docs/guide/yaml/defining-applications/mysql-in-catalog-w700.png
differ

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/guide/yaml/defining-applications/mysql-in-catalog.png
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/defining-applications/mysql-in-catalog.png b/docs/guide/yaml/defining-applications/mysql-in-catalog.png
new file mode 100644
index 0000000..685455d
Binary files /dev/null and b/docs/guide/yaml/defining-applications/mysql-in-catalog.png differ

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/guide/yaml/defining-applications/web-console-yaml-700.png
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/defining-applications/web-console-yaml-700.png b/docs/guide/yaml/defining-applications/web-console-yaml-700.png
new file mode 100644
index 0000000..d6a2249
Binary files /dev/null and b/docs/guide/yaml/defining-applications/web-console-yaml-700.png
differ

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/guide/yaml/defining-applications/web-console-yaml.png
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/defining-applications/web-console-yaml.png b/docs/guide/yaml/defining-applications/web-console-yaml.png
new file mode 100644
index 0000000..3d65a99
Binary files /dev/null and b/docs/guide/yaml/defining-applications/web-console-yaml.png differ

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/guide/yaml/defining-applications/yaml-reference.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/defining-applications/yaml-reference.md b/docs/guide/yaml/defining-applications/yaml-reference.md
new file mode 100644
index 0000000..df19dd3
--- /dev/null
+++ b/docs/guide/yaml/defining-applications/yaml-reference.md
@@ -0,0 +1,183 @@
+---
+title: Broooklyn YAML Blueprint Reference
+layout: guide-normal
+toc: ../guide_toc.json
+categories: [use, guide, defining-applications]
+---
+
+## Root Elements
+
+* `name`: human readable names
+* `services`: a list of `ServiceSpecification` elements
+* `location` (or `locations` taking a list): a `LocationSpecification` element as a string
or a map
+
+
+## `ServiceSpecification` Elements
+
+Within the `services` block, a list of maps should be supplied, with each map
+defining a `ServiceSpecification`.  Each `ServiceSpecification` should declare the
+service `type` (synonyms `serviceType` and `service_type`), indicating what type of 
+service is being specified there.  The following formats are supported for
+defining types:
+
+* `io.brooklyn.package.JavaEntityClass`
+* `java:io.brooklyn.package.JavaEntityClass`
+* *OSGi and YAML references are coming soon!* <!-- TODO -->
+
+A reference of some of the common service `type` instances used is included in a section
below.
+
+Within the `ServiceSpecification`, other key-value pairs can be supplied to customize
+the entity being defined, with these being the most common:
+
+* `id`: an ID string, used to refer to this service
+
+* `location` (or `locations`): as defined in the root element 
+  
+* `brooklyn.config`: configuration key-value pairs passed to the service entity being created
+
+* `brooklyn.children`: a list of `ServiceSpecifications` which will be configured as children
of this entity
+
+* `brooklyn.policies`: a list of policies, each as a map described with their `type` and
their `brooklyn.config` as keys
+
+* `brooklyn.enrichers`: a list of enrichers, each as a map described with their `type` and
their `brooklyn.config` as keys
+
+* `brooklyn.initializers`: a list of `EntityInitializer` instances to be constructed and
run against the entity, 
+  each as a map described with their `type` and their `brooklyn.config` as keys.
+  An `EntityInitiailzer` can perform arbitrary customization to an entity whilst it is being
constructed,
+  such as adding dynamic sensors and effectors. These classes must expose a public constructor
taking
+  a single `Map` where the `brooklyn.config` is passed in.
+  Some common initializers are:
+  
+  * `brooklyn.entity.software.ssh.SshCommandEffector`: takes a `name` and `command`,
+    and optionally a map of named `parameters` to their `description` and `defaultValue`,
+    to define an effector with the given name implemented by the given SSH command
+    (on an entity which as an ssh-able machine)
+
+  * `brooklyn.entity.software.ssh.SshCommandSensor`: takes a `name` and `command`,
+    and optionally a `period`, to create a sensor feed which populates the sensor with
+    the given name by running the given command (on an entity which as an ssh-able machine)

+
+Entities, policies, and initializers may accept additional key-value pairs, 
+usually documented in their documentation (e.g. javadoc), or in the case of Java
+often as static fields in the underlying Java class.
+Often there are config keys or flags (indicated by `@SetFromFlag`) declared on the class;

+these declared flags and config keys may be passed in at the root of the `ServiceSpecification`
or in `brooklyn.config`.
+(Undeclared config is only accepted in the `brooklyn.config` map.)
+
+
+## `LocationSpecification` Elements
+
+<!-- TODO - expand this, currently it's concise notes -->
+
+In brief, location specs are supplied as follows, either for the entire application (at the
root)
+or for a specific `ServiceSpecification`:
+
+    location:
+      jclouds:aws-ec2:
+        region: us-east-1
+        identity: AKA_YOUR_ACCESS_KEY_ID
+        credential: <access-key-hex-digits>
+
+Or in many cases it can be in-lined:
+
+    location: localhost
+    location: named:my_openstack
+    location: aws-ec2:us-west-1
+
+For the first immediately, you'll need password-less ssh access to localhost.
+For the second, you'll need to define a named location in `brooklyn.properties`,
+using `brooklyn.location.named.my_openstack....` properties.
+For the third, you'll need to have the identity and credentials defined in
+`brooklyn.properties`, using `brooklyn.location.jclouds.aws-ec2....` properties.
+
+If specifying multiple locations, e.g. for a fabric:
+
+    locations:
+    - localhost
+    - named:my_openstack
+    - aws-ec2:us-east-2   # if credentials defined in `brooklyn.properties
+    - jclouds:aws-ec2:
+        region: us-east-1
+        identity: AKA_YOUR_ACCESS_KEY_ID
+        credential: <access-key-hex-digits>
+
+If you have pre-existing nodes, you can use the `byon` provider, either in this format:
+
+    location:
+      byon:
+        user: root
+        privateKeyFile: ~/.ssh/key.pem
+        hosts:
+        - 81.95.144.58
+        - 81.95.144.59
+        - brooklyn@159.253.144.139
+        - brooklyn@159.253.144.140
+
+or:
+
+    location:
+      byon:
+        user: root
+        privateKeyFile: ~/.ssh/key.pem
+        hosts: "{81.95.144.{58,59},brooklyn@159.253.144.{139-140}"
+
+You cannot use glob expansions with the list notation, nor can you specify per-host
+information apart from user within a single `byon` declaration.
+However you can combine locations using `multi`:
+
+    location:
+      multi:
+        targets:
+        - byon:
+            user: root
+            privateKeyFile: ~/.ssh/key.pem
+            hosts:
+            - 81.95.144.58
+            - 81.95.144.59
+        - byon:
+            privateKeyFile: ~/.ssh/brooklyn_key.pem
+            hosts: brooklyn@159.253.144{139-140}
+
+
+## DSL Commands
+
+Dependency injection other powerful references and types can be built up within the YAML
using the
+concise DSL defined here:
+ 
+* `$brooklyn:component("ID")` refers to a Brooklyn component with the given ID; you can then
access the following subfields:
+  * `.attributeWhenReady("sensor")` will store a future which will be blocked when it is
accessed,
+    until the given `sensor` from the component `ID` has a "truthy" (i.e. non-trivial, non-empty,
non-zero) value
+  * `.config("key")` will insert the value set against the given key at this entity (or nearest
ancestor);
+    can be used to supply config at the root which is used in multiple places in the plan
+* `$brooklyn:component("scope", "ID")` is also supported, to limit scope to any of
+  * `global`: looks for the `ID` anywhere in the plan
+  * `child`: looks for the `ID` anywhere in the child only
+  * `descendant`: looks for the `ID` anywhere in children or their descendants
+  * `sibling`: looks for the `ID` anywhere among children of the parent entity
+  * `parent`: returns the parent entity (ignores the `ID`)
+  * `this`: returns this entity (ignores the `ID`)
+* `$brooklyn:formatString("pattern e.g. %s %s", "field 1", "field 2")` returns a future which
creates the formatted string
+  with the given parameters, where parameters may be strings *or* other tasks such as `attributeWhenReady`
+* `$brooklyn:literal("string")` returns the given string as a literal (suppressing any `$brooklyn:`
expansion)
+* `$brooklyn:sensor("io.brooklyn.ContainingEntityClass", "sensor.name")` returns the strongly
typed sensor defined in the given class
+* `$brooklyn:entitySpec(Map)` returns a new `ServiceSpecification` as defined by the given
`Map`,
+  but as an `EntitySpec` suitable for setting as the value of `ConfigKey<EntitySpec>`
config items
+  (such as `memberSpec` in `DynamicCluster`)
+
+These can be supplied either as strings or as lists and maps in YAML. 
+
+
+## Some Powerful YAML Entities
+
+All entities support configuration via YAML, but these entities in particular 
+have been designed for general purpose use from YAML.  Consult the Javadoc for these
+elements for more information:
+
+* **Vanilla Software** in `VanillaSoftwareProcess`: makes it very easy to build entities
+  which use `bash` commands to install and the PID to stop and restart
+* **Chef** in `ChefSoftwareProcess`: makes it easy to use Chef cookbooks to build entities,
+  either with recipes following conventions or with configuration in the `ServiceSpecification`
+  to use artibitrary recipes 
+* `DynamicCluster`: provides resizable clusters given a `memberSpec` set with `$brooklyn.entitySpec(Map)`
as described above 
+* `DynamicFabric`: provides a set of homogeneous instances started in different locations,
+  with an effector to `addLocation`, i.e. add a new instance in a given location, at runtime

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/guide/yaml/index.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/index.md b/docs/guide/yaml/index.md
index 58f2696..a32ac59 100644
--- a/docs/guide/yaml/index.md
+++ b/docs/guide/yaml/index.md
@@ -2,7 +2,12 @@
 title: YAML
 layout: website-normal
 children:
-- { path: p1.md }
-- { path: p2.md }
+- defining-applications/creating-yaml.md
+- defining-applications/deploying-yaml.md
+- defining-applications/catalog-maintenance.md
+- defining-applications/chef-blueprints.md
+- defining-applications/common-usage.md
+- defining-applications/examples.md
+- defining-applications/yaml-reference.md
 ---
 

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/guide/yaml/p1.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/p1.md b/docs/guide/yaml/p1.md
deleted file mode 100644
index e8fb159..0000000
--- a/docs/guide/yaml/p1.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-title: Page 1
-layout: website-normal
----
-

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/guide/yaml/p2.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/p2.md b/docs/guide/yaml/p2.md
deleted file mode 100644
index 70a5ef3..0000000
--- a/docs/guide/yaml/p2.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: Page 2
-layout: website-normal
-children:
-- { path: p2p1.md }
----
-

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/guide/yaml/p2p1.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/p2p1.md b/docs/guide/yaml/p2p1.md
deleted file mode 100644
index fe97c95..0000000
--- a/docs/guide/yaml/p2p1.md
+++ /dev/null
@@ -1,7 +0,0 @@
----
-title: Page 2.1
-layout: website-normal
-children:
-- { path: p2p1p1.md }
----
-

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/guide/yaml/p2p1p1.md
----------------------------------------------------------------------
diff --git a/docs/guide/yaml/p2p1p1.md b/docs/guide/yaml/p2p1p1.md
deleted file mode 100644
index 1004da4..0000000
--- a/docs/guide/yaml/p2p1p1.md
+++ /dev/null
@@ -1,5 +0,0 @@
----
-title: Page 2.1.1
-layout: website-normal
----
-

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/website/community/extra/links.md
----------------------------------------------------------------------
diff --git a/docs/website/community/extra/links.md b/docs/website/community/extra/links.md
new file mode 100644
index 0000000..6fd12e2
--- /dev/null
+++ b/docs/website/community/extra/links.md
@@ -0,0 +1,22 @@
+---
+layout: guide-normal
+title: Development Bookmarks
+toc: ../toc.json
+---
+
+{% include fields.md %}
+
+Handy places:
+
+* **Code** is in Github at [https://github.com/apache/incubator-brooklyn/](https://github.com/apache/incubator-brooklyn/)
+
+* **Issues** are in Jira at [https://issues.apache.org/jira/browse/BROOKLYN/](https://issues.apache.org/jira/browse/BROOKLYN/)
+
+* **Maven repositories** are:
+  * [Apache releases]({{ apache_releases_repo_groupid_url }})
+  * [Apache snapshots]({{ apache_snapshots_repo_groupid_url }})
+  * Other repositories are at [http://developers.cloudsoftcorp.com/download/maven2/](http://developers.cloudsoftcorp.com/download/maven2/)
for releases 
+  and [http://ccweb.cloudsoftcorp.com/maven/libs-snapshot-local/](http://ccweb.cloudsoftcorp.com/maven/libs-snapshot-local/)
for snapshots
+            
+* **CI server** is a jenkins server at: [https://builds.apache.org/job/incubator-brooklyn-master-build/](https://builds.apache.org/job/incubator-brooklyn-master-build/)
+

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/website/documentation/faq.md
----------------------------------------------------------------------
diff --git a/docs/website/documentation/faq.md b/docs/website/documentation/faq.md
new file mode 100644
index 0000000..26a3fa8
--- /dev/null
+++ b/docs/website/documentation/faq.md
@@ -0,0 +1,7 @@
+---
+title: FAQ
+layout: website-normal
+---
+
+TODO
+

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/website/documentation/index.md
----------------------------------------------------------------------
diff --git a/docs/website/documentation/index.md b/docs/website/documentation/index.md
index 7784708..90699ff 100644
--- a/docs/website/documentation/index.md
+++ b/docs/website/documentation/index.md
@@ -2,10 +2,10 @@
 layout: website-normal
 title: Documentation
 children:
-- { path: /guide/index.md, title_in_menu: "User Guide {{ site.brooklyn-stable-version }}"
}
-- { path: todo.md, title_in_menu: Developer Guide }
-- { path: todo.md, title_in_menu: FAQ }
-- { path: other-docs.md, title_in_menu: Other Resources }
+- /guide/
+- /guide/dev/
+- faq.md
+- other-docs.md
 ---
 
 TODO kill me

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/website/index.md
----------------------------------------------------------------------
diff --git a/docs/website/index.md b/docs/website/index.md
index d8755ae..aa180f7 100644
--- a/docs/website/index.md
+++ b/docs/website/index.md
@@ -8,14 +8,15 @@ children:
 - { path: quickstart/, title: Get Started }
 - path: documentation/
   menu:
-  - { path: /guide/index.md, title_in_menu: "User Guide {{ site.brooklyn-stable-version }}",

+  - { path: /guide/index.md, title_in_menu: "User Guide", 
       menu_customization: { dropdown_section_header: true } }
   - { path: /guide/yaml/index.md, title_in_menu: YAML Blueprints }
   - { path: /guide/java/index.md, title_in_menu: Java Blueprints }
-  - { path: /guide/ops/index.md, title_in_menu: Operations }
-  - { path: documentation/todo.md, title_in_menu: Developer Guide, 
+  - { path: /guide/ops/index.md, title_in_menu: Operations,
+      menu_customization: { dropdown_section_header: true } }
+  - { path: /guide/dev/index.md, title_in_menu: Developer Guide }
+  - { path: documentation/faq.md, title_in_menu: FAQ,
       menu_customization: { dropdown_new_section: true } }
-  - { path: documentation/todo.md, title_in_menu: FAQ }
   - { path: documentation/other-docs.md, title_in_menu: Other Resources }
 - community/
 ---

http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/1d6ce7cf/docs/website/meta/license.md
----------------------------------------------------------------------
diff --git a/docs/website/meta/license.md b/docs/website/meta/license.md
new file mode 100644
index 0000000..4913567
--- /dev/null
+++ b/docs/website/meta/license.md
@@ -0,0 +1,205 @@
+---
+layout: guide-normal
+title: Legal
+---
+
+## License
+
+Apache Brooklyn is released to the public as open source under the 
+terms of the [Apache License, v2.0](http://www.apache.org/licenses/LICENSE-2.0), a full copy
of
+which is included below for reference.
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+Apache Brooklyn is currently undergoing Incubation at the Apache Software Foundation.
+
+
+## Trademark
+
+The Brooklyn name and logo are trademarks owned by the Apache Software Foundation.
+
+
+## Apache License, v2.0 (reference copy)
+
+
+{% highlight text %}
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+{% endhighlight %} 


Mime
View raw message