Repository: incubator-brooklyn Updated Branches: refs/heads/master a440080f4 -> a6265834f
Docs: move install-on-server to guide/ops - Was previously in âother docsâ. Project: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/commit/2a2f98c8 Tree: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/tree/2a2f98c8 Diff: http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/diff/2a2f98c8 Branch: refs/heads/master Commit: 2a2f98c8bc25ed807ea17404544d6d14c849c4a9 Parents: eab2d39 Author: Aled Sage <[email protected]> Authored: Tue Feb 24 07:01:16 2015 +0000 Committer: Aled Sage <[email protected]> Committed: Tue Feb 24 07:01:16 2015 +0000 ---------------------------------------------------------------------- docs/guide/ops/index.md | 1 + docs/guide/ops/install-on-server.md | 128 +++++++++++++++++++ docs/website/documentation/install-on-server.md | 128 ------------------- docs/website/documentation/other-docs.md | 1 - 4 files changed, 129 insertions(+), 129 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2a2f98c8/docs/guide/ops/index.md ---------------------------------------------------------------------- diff --git a/docs/guide/ops/index.md b/docs/guide/ops/index.md index 6b523f6..3e6305a 100644 --- a/docs/guide/ops/index.md +++ b/docs/guide/ops/index.md @@ -2,6 +2,7 @@ title: Operations layout: website-normal children: +- install-on-server.md - cli.md - brooklyn_properties.md - locations/ http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2a2f98c8/docs/guide/ops/install-on-server.md ---------------------------------------------------------------------- diff --git a/docs/guide/ops/install-on-server.md b/docs/guide/ops/install-on-server.md new file mode 100644 index 0000000..67dc6da --- /dev/null +++ b/docs/guide/ops/install-on-server.md @@ -0,0 +1,128 @@ +--- +layout: website-normal +title: Installing on a Server +--- + +{% include fields.md %} + +Here we present two *alternatives* to install Brooklyn: + +- [Running the *installation script*](#script) +- [Manual installation](#manual) + +## <a id="script"></a> Running the installation script +There is a simple bash script available to help with the installation process. + +#### Script prerequisites +The script assumes that the server is a recent *RHEL/CentOS 6.x Linux* or *Ubuntu 12.04* installation, but other Linux variants have been tested successfully. + +The script will install Java 7 and other required packages if they are not present. +You must have root access over [passwordless SSH]({{ site.path.guide }}/ops/locations/ssh-keys.html) +to install brooklyn, but the service runs as an ordinary user once installed. + +To manage the brooklyn service you must also be able to connect to port 8081 remotely. + +Once the above prerequisites are satisfied, you should be able to run successfully: +{% highlight bash %} +$ curl -o brooklyn-install.sh -L https://github.com/apache/incubator-brooklyn/raw/master/brooklyn-install.sh +$ chmod +x ./brooklyn-install.sh +$ ./brooklyn-install.sh -s -r <your-server-ip> +{% endhighlight %} + +## <a id="manual"></a> Manual installation + +1. [Set up the prerequisites](#prerequisites) +1. [Download Brooklyn](#download) +1. [Configuring brooklyn.properties](#configuring-properties) +1. [Configuring catalog.xml](#configuring-catalog) +1. [Test the installation](#confirm) + +### <a id="prerequisites"></a>Set up the prerequisites + +Before installing Apache Brooklyn, it is recommented to configure the host as follows. + +* install Java JRE or SDK (version 6 or later) +* install an [SSH key]({{ site.path.guide }}/ops/locations/ssh-keys.html), if not available +* enable [passwordless ssh login]({{ site.path.guide }}/ops/locations/ssh-keys.html) +* create a `~/.brooklyn` directory on the host with `$ mkdir ~/.brooklyn` +* check your `iptables` or other firewall service, making sure that incoming connections on port 8443 is not blocked +* check that the [linux kernel entropy](increase-entropy.html) is sufficient + + +## <a id="download"></a>Download Brooklyn + +Download Brooklyn and obtain a binary build as described on [the download page]({{site.path.website}}/download/). + +{% if brooklyn_version contains 'SNAPSHOT' %} +Expand the `tar.gz` archive (note: as this is a -SNAPSHOT version, your filename will be slightly different): +{% else %} +Expand the `tar.gz` archive: +{% endif %} + +{% if brooklyn_version contains 'SNAPSHOT' %} +{% highlight bash %} +$ tar -zxf brooklyn-dist-{{ site.brooklyn-stable-version }}-timestamp-dist.tar.gz +{% endhighlight %} +{% else %} +{% highlight bash %} +$ tar -zxf brooklyn-{{ site.brooklyn-stable-version }}-dist.tar.gz +{% endhighlight %} +{% endif %} + +This will create a `brooklyn-{{ site.brooklyn-stable-version }}` folder. + +Let's setup some paths for easy commands. + +{% highlight bash %} +$ cd brooklyn-{{ site.brooklyn-stable-version }} +$ BROOKLYN_DIR="$(pwd)" +$ export PATH=$PATH:$BROOKLYN_DIR/bin/ +{% endhighlight %} + +## <a id="configuring-properties"></a>Configuring brooklyn.properties +Brooklyn deploys applications to Locations. *Locations* can be clouds, machines with fixed IPs or localhost (for testing). + +By default Brooklyn loads configuration parameters (including credentials for any cloud accounts) from + +`~/.brooklyn/brooklyn.properties` + +The `brooklyn.properties` is the main configuration file for deployment locations. Contains the connection details and credentials for all public or on-premises cloud providers, as well as controlling some application startup and security options. + +Create a `.brooklyn` folder in your home directory and download the template [brooklyn.properties]({{brooklyn_properties_url_path}}) to that folder. + +{% highlight bash %} +$ mkdir -p ~/.brooklyn +$ wget -O ~/.brooklyn/brooklyn.properties {{brooklyn_properties_url_live}} +$ chmod 600 ~/.brooklyn/brooklyn.properties +{% endhighlight %} + +You may need to edit `~/.brooklyn/brooklyn.properties` to ensure that brooklyn can access cloud locations for application deployment. + +## <a id="configuring-catalog"></a>Configuring catalog.xml +By default Brooklyn loads the catalog of available application components and services from +`~/.brooklyn/catalog.xml`. + +{% highlight bash %} +$ wget -O ~/.brooklyn/catalog.xml {{site.url_root}}{{site.path.website}}/quickstart/catalog.xml +{% endhighlight %} + +The `catalog.xml` is the application blueprint catalog. The above example file contains some blueprints which will be automatically downloaded from the web if you run them. + +You may need to edit `~/.brooklyn/catalog.xml` to update links to any resources for download. + +## <a id="confirm"></a>Confirm installation +We can do a quick test drive by launching Brooklyn: + +{% highlight bash %} +$ brooklyn launch +{% endhighlight %} + +Brooklyn will output the address of the management interface: + +{% highlight bash %} +INFO Starting brooklyn web-console on loopback interface because no security config is set + +INFO Started Brooklyn console at http://127.0.0.1:8081/, running classpath://brooklyn.war and [] +{% endhighlight %} + +Stop Brooklyn with ctrl-c. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2a2f98c8/docs/website/documentation/install-on-server.md ---------------------------------------------------------------------- diff --git a/docs/website/documentation/install-on-server.md b/docs/website/documentation/install-on-server.md deleted file mode 100644 index 67dc6da..0000000 --- a/docs/website/documentation/install-on-server.md +++ /dev/null @@ -1,128 +0,0 @@ ---- -layout: website-normal -title: Installing on a Server ---- - -{% include fields.md %} - -Here we present two *alternatives* to install Brooklyn: - -- [Running the *installation script*](#script) -- [Manual installation](#manual) - -## <a id="script"></a> Running the installation script -There is a simple bash script available to help with the installation process. - -#### Script prerequisites -The script assumes that the server is a recent *RHEL/CentOS 6.x Linux* or *Ubuntu 12.04* installation, but other Linux variants have been tested successfully. - -The script will install Java 7 and other required packages if they are not present. -You must have root access over [passwordless SSH]({{ site.path.guide }}/ops/locations/ssh-keys.html) -to install brooklyn, but the service runs as an ordinary user once installed. - -To manage the brooklyn service you must also be able to connect to port 8081 remotely. - -Once the above prerequisites are satisfied, you should be able to run successfully: -{% highlight bash %} -$ curl -o brooklyn-install.sh -L https://github.com/apache/incubator-brooklyn/raw/master/brooklyn-install.sh -$ chmod +x ./brooklyn-install.sh -$ ./brooklyn-install.sh -s -r <your-server-ip> -{% endhighlight %} - -## <a id="manual"></a> Manual installation - -1. [Set up the prerequisites](#prerequisites) -1. [Download Brooklyn](#download) -1. [Configuring brooklyn.properties](#configuring-properties) -1. [Configuring catalog.xml](#configuring-catalog) -1. [Test the installation](#confirm) - -### <a id="prerequisites"></a>Set up the prerequisites - -Before installing Apache Brooklyn, it is recommented to configure the host as follows. - -* install Java JRE or SDK (version 6 or later) -* install an [SSH key]({{ site.path.guide }}/ops/locations/ssh-keys.html), if not available -* enable [passwordless ssh login]({{ site.path.guide }}/ops/locations/ssh-keys.html) -* create a `~/.brooklyn` directory on the host with `$ mkdir ~/.brooklyn` -* check your `iptables` or other firewall service, making sure that incoming connections on port 8443 is not blocked -* check that the [linux kernel entropy](increase-entropy.html) is sufficient - - -## <a id="download"></a>Download Brooklyn - -Download Brooklyn and obtain a binary build as described on [the download page]({{site.path.website}}/download/). - -{% if brooklyn_version contains 'SNAPSHOT' %} -Expand the `tar.gz` archive (note: as this is a -SNAPSHOT version, your filename will be slightly different): -{% else %} -Expand the `tar.gz` archive: -{% endif %} - -{% if brooklyn_version contains 'SNAPSHOT' %} -{% highlight bash %} -$ tar -zxf brooklyn-dist-{{ site.brooklyn-stable-version }}-timestamp-dist.tar.gz -{% endhighlight %} -{% else %} -{% highlight bash %} -$ tar -zxf brooklyn-{{ site.brooklyn-stable-version }}-dist.tar.gz -{% endhighlight %} -{% endif %} - -This will create a `brooklyn-{{ site.brooklyn-stable-version }}` folder. - -Let's setup some paths for easy commands. - -{% highlight bash %} -$ cd brooklyn-{{ site.brooklyn-stable-version }} -$ BROOKLYN_DIR="$(pwd)" -$ export PATH=$PATH:$BROOKLYN_DIR/bin/ -{% endhighlight %} - -## <a id="configuring-properties"></a>Configuring brooklyn.properties -Brooklyn deploys applications to Locations. *Locations* can be clouds, machines with fixed IPs or localhost (for testing). - -By default Brooklyn loads configuration parameters (including credentials for any cloud accounts) from - -`~/.brooklyn/brooklyn.properties` - -The `brooklyn.properties` is the main configuration file for deployment locations. Contains the connection details and credentials for all public or on-premises cloud providers, as well as controlling some application startup and security options. - -Create a `.brooklyn` folder in your home directory and download the template [brooklyn.properties]({{brooklyn_properties_url_path}}) to that folder. - -{% highlight bash %} -$ mkdir -p ~/.brooklyn -$ wget -O ~/.brooklyn/brooklyn.properties {{brooklyn_properties_url_live}} -$ chmod 600 ~/.brooklyn/brooklyn.properties -{% endhighlight %} - -You may need to edit `~/.brooklyn/brooklyn.properties` to ensure that brooklyn can access cloud locations for application deployment. - -## <a id="configuring-catalog"></a>Configuring catalog.xml -By default Brooklyn loads the catalog of available application components and services from -`~/.brooklyn/catalog.xml`. - -{% highlight bash %} -$ wget -O ~/.brooklyn/catalog.xml {{site.url_root}}{{site.path.website}}/quickstart/catalog.xml -{% endhighlight %} - -The `catalog.xml` is the application blueprint catalog. The above example file contains some blueprints which will be automatically downloaded from the web if you run them. - -You may need to edit `~/.brooklyn/catalog.xml` to update links to any resources for download. - -## <a id="confirm"></a>Confirm installation -We can do a quick test drive by launching Brooklyn: - -{% highlight bash %} -$ brooklyn launch -{% endhighlight %} - -Brooklyn will output the address of the management interface: - -{% highlight bash %} -INFO Starting brooklyn web-console on loopback interface because no security config is set - -INFO Started Brooklyn console at http://127.0.0.1:8081/, running classpath://brooklyn.war and [] -{% endhighlight %} - -Stop Brooklyn with ctrl-c. http://git-wip-us.apache.org/repos/asf/incubator-brooklyn/blob/2a2f98c8/docs/website/documentation/other-docs.md ---------------------------------------------------------------------- diff --git a/docs/website/documentation/other-docs.md b/docs/website/documentation/other-docs.md index a6d01df..0b80ce7 100644 --- a/docs/website/documentation/other-docs.md +++ b/docs/website/documentation/other-docs.md @@ -3,7 +3,6 @@ title: Other Resources layout: website-normal children: - { path: glossary.md } -- { path: install-on-server.md } - { path: ../meta/versions.md } - { path: ../meta/sitemap.md } ---
