docker-library
/
docs
mirror of https://github.com/docker-library/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Tweak aerospike formatting for markdownfmt

This commit is contained in:
Tianon Gravi 2015-02-27 16:44:51 -07:00
parent af3743b5df
commit 2104e4fdc2
4 changed files with 45 additions and 138 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
aerospike/README-short.txt
View File

@ -1,2 +1 @@
Aerospike – the reliable, high performance, distributed database optimized for Aerospike – the reliable, high performance, distributed database optimized for flash and RAM.
flash and RAM.

102
aerospike/README.md
View File

@ -1,34 +1,26 @@
# Supported tags and respective `Dockerfile` links # Supported tags and respective `Dockerfile` links
- [`3.5.3`, `latest` (*Dockerfile*)](https://github.com/aerospike/aerospike-server.docker/blob/001bf913432989f30e19816467b0e0e8430730bc/Dockerfile)
For more information about this image and its history, please see the [relevant manifest file (`library/aerospike`)](https://github.com/docker-library/official-images/blob/master/library/aerospike) in the [`docker-library/official-images` GitHub repo](https://github.com/docker-library/official-images).
For more information about this image and its history, please see the [relevant # Aerospike
manifest file
(`library/aerospike`)](https://github.com/docker-library/official-images/blob/master/library/aerospike)
in the [`docker-library/official-images` GitHub
repo](https://github.com/docker-library/official-images).
# Aerospike Aerospike is an open source distributed database. Aerospike is built on a "shared nothing" architecture designed to reliably store terabytes of data with automatic fail-over, replication and cross data-center synchronization.
Aerospike is an open source distributed database. Aerospike is built on a
"shared nothing" architecture designed to reliably stores terabytes of data
with automatic fail-over, replication and cross data-center synchronization.
![logo](https://raw.githubusercontent.com/docker-library/docs/master/aerospike/logo.png) ![logo](https://raw.githubusercontent.com/docker-library/docs/master/aerospike/logo.png)
Documentation for Aerospike is available at [http://aerospike.com/docs](http://aerospike.com/docs). Documentation for Aerospike is available at [http://aerospike.com/docs](https://www.aerospike.com/docs).
# Using this Image # Using this Image
The following will run `asd` with all the exposed ports forward to the host machine. The following will run `asd` with all the exposed ports forward to the host machine.
docker run -tid --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server docker run -d --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server
**NOTE** Although this is the simplest method to getting Aerospike up and running, but it is not the preferred method. To properly run the container, please specify an **custom configuration** with the **access-address** defined. **NOTE** Although this is the simplest method to getting Aerospike up and running, but it is not the preferred method. To properly run the container, please specify an **custom configuration** with the **access-address** defined.
# Advanced Usage
# Advanced Usage
## Custom Configuration ## Custom Configuration
@ -37,14 +29,14 @@ By default, `asd` will use the configuration file in `/etc/aerospike/aerospike.c
-v <DIRECTORY>:/opt/aerospike/etc -v <DIRECTORY>:/opt/aerospike/etc
Where `<DIRECTORY>` is the path to a directory containing your custom configuration file. Next, you will want to tell `asd` to use a configuration file from `/opt/aerospike/etc`, by using the `--config-file` option for `aerospike/aerospike-server`: Where `<DIRECTORY>` is the path to a directory containing your custom configuration file. Next, you will want to tell `asd` to use a configuration file from `/opt/aerospike/etc`, by using the `--config-file` option for `aerospike/aerospike-server`:
--config-file /opt/aerospike/etc/aerospike.conf --config-file /opt/aerospike/etc/aerospike.conf
This will use tell `asd` to use the file in `/opt/aerospike/etc/aerospike.conf`, which is mapped to `<DIRECTORY>/aerospike.conf`. This will use tell `asd` to use the file in `/opt/aerospike/etc/aerospike.conf`, which is mapped to `<DIRECTORY>/aerospike.conf`.
A full example: A full example:
docker run -tid -v <DIRECTORY>:/opt/aerospike/etc --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server --config-file /opt/aerospike/etc/aerospike.conf docker run -d -v <DIRECTORY>:/opt/aerospike/etc --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server asd --foreground --config-file /opt/aerospike/etc/aerospike.conf
## access-address Configuration ## access-address Configuration
@ -53,14 +45,12 @@ In order for Aerospike to properly broadcast its address to the cluster or appli
To specify **access-address** in aerospike.conf: To specify **access-address** in aerospike.conf:
network { network {
service { service {
address any # Listening IP Address address any # Listening IP Address
port 3000 # Listening Port port 3000 # Listening Port
access-address 192.168.1.100 # IP Address to be used by applications access-address 192.168.1.100 # IP Address to be used by applications and other nodes in the cluster.
# and other nodes in the cluster. }
} ...
...
## Persistent Data Directory ## Persistent Data Directory
@ -72,8 +62,7 @@ Where `<DIRECTORY>` is the path to a directory containing your data files.
A full example: A full example:
docker run -tid -v <DIRECTORY>:/opt/aerospike/data --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server docker run -d -v <DIRECTORY>:/opt/aerospike/data --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server
## Clustering ## Clustering
@ -83,18 +72,20 @@ Aerospike recommends using multicast clustering whenever possible, however, we a
Mesh networking requires setting up links between each node in the cluster. This can be achieved in two ways: Mesh networking requires setting up links between each node in the cluster. This can be achieved in two ways:
1. Define a configuration for each node in the cluster, as defined in [Network Heartbeat Configuration](http://www.aerospike.com/docs/operations/configure/network/heartbeat/#mesh-unicast-heartbeat). 1. Define a configuration for each node in the cluster, as defined in [Network Heartbeat Configuration](http://www.aerospike.com/docs/operations/configure/network/heartbeat/#mesh-unicast-heartbeat).
2. Use `asinfo` to send the `tip` command, to make the node aware of another node, as defined in [tip command in asinfo](http://www.aerospike.com/docs/tools/asinfo/#tip).
2. Use `asinfo` to send the `tip` command, to make the node aware of another node, as defined in [tip command in asinfo](http://www.aerospike.com/docs/tools/asinfo/#tip).
# License
Copyright 2014-2015 Aerospike, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
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.
# Supported Docker versions # Supported Docker versions
This image is officially supported on Docker version 1.4.1. This image is officially supported on Docker version 1.5.0.
Support for older versions (down to 1.0) is provided on a best-effort basis. Support for older versions (down to 1.0) is provided on a best-effort basis.
@ -104,53 +95,10 @@ Support for older versions (down to 1.0) is provided on a best-effort basis.
If you have any problems with or questions about this image, please contact us on the [Aerospike Forums](discuss.aerospike.com) or through a [GitHub issue](https://github.com/aerospike/aerospike-server.docker/issues). If you have any problems with or questions about this image, please contact us on the [Aerospike Forums](discuss.aerospike.com) or through a [GitHub issue](https://github.com/aerospike/aerospike-server.docker/issues).
You can also reach many of the official image maintainers via the `#docker-library` IRC channel on [Freenode](https://freenode.net).
## Contributing ## Contributing
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can. You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
Before you start to code, we recommend discussing your plans on the [Aerospike Forums](discuss.aerospike.com) or through a [GitHub issue](https://github.com/aerospike/aerospike-server.docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing. Before you start to code, we recommend discussing your plans on the [Aerospike Forums](discuss.aerospike.com) or through a [GitHub issue](https://github.com/aerospike/aerospike-server.docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.
# License
Copyright 2014-2015 Aerospike, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
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.
# Supported Docker versions
This image is officially supported on Docker version 1.4.1.
Support for older versions (down to 1.0) is provided on a best-effort basis.
# User Feedback
## Issues
If you have any problems with or questions about this image, please contact us
through a [GitHub issue](https://github.com/aerospike/aerospike-server.docker/issues).
You can also reach many of the official image maintainers via the
`#docker-library` IRC channel on [Freenode](https://freenode.net).
## Contributing
You are invited to contribute new features, fixes, or updates, large or small;
we are always thrilled to receive pull requests, and do our best to process them
as fast as we can.
Before you start to code, we recommend discussing your plans
through a [GitHub issue](https://github.com/aerospike/aerospike-server.docker/issues), especially for more ambitious
contributions. This gives other contributors a chance to point you in the right
direction, give you feedback on your design, and help you find out if someone
else is working on the same thing.

66
aerospike/content.md
View File

@ -1,24 +1,20 @@
# Aerospike # Aerospike
Aerospike is an open source distributed database. Aerospike is built on a Aerospike is an open source distributed database. Aerospike is built on a "shared nothing" architecture designed to reliably store terabytes of data with automatic fail-over, replication and cross data-center synchronization.
"shared nothing" architecture designed to reliably stores terabytes of data
with automatic fail-over, replication and cross data-center synchronization.
%%LOGO%% %%LOGO%%
Documentation for Aerospike is available at [http://aerospike.com/docs](http://aerospike.com/docs). Documentation for Aerospike is available at [http://aerospike.com/docs](https://www.aerospike.com/docs).
# Using this Image # Using this Image
The following will run `asd` with all the exposed ports forward to the host machine. The following will run `asd` with all the exposed ports forward to the host machine.
docker run -tid --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server docker run -d --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server
**NOTE** Although this is the simplest method to getting Aerospike up and running, but it is not the preferred method. To properly run the container, please specify an **custom configuration** with the **access-address** defined. **NOTE** Although this is the simplest method to getting Aerospike up and running, but it is not the preferred method. To properly run the container, please specify an **custom configuration** with the **access-address** defined.
# Advanced Usage
# Advanced Usage
## Custom Configuration ## Custom Configuration
@ -27,14 +23,14 @@ By default, `asd` will use the configuration file in `/etc/aerospike/aerospike.c
-v <DIRECTORY>:/opt/aerospike/etc -v <DIRECTORY>:/opt/aerospike/etc
Where `<DIRECTORY>` is the path to a directory containing your custom configuration file. Next, you will want to tell `asd` to use a configuration file from `/opt/aerospike/etc`, by using the `--config-file` option for `aerospike/aerospike-server`: Where `<DIRECTORY>` is the path to a directory containing your custom configuration file. Next, you will want to tell `asd` to use a configuration file from `/opt/aerospike/etc`, by using the `--config-file` option for `aerospike/aerospike-server`:
--config-file /opt/aerospike/etc/aerospike.conf --config-file /opt/aerospike/etc/aerospike.conf
This will use tell `asd` to use the file in `/opt/aerospike/etc/aerospike.conf`, which is mapped to `<DIRECTORY>/aerospike.conf`. This will use tell `asd` to use the file in `/opt/aerospike/etc/aerospike.conf`, which is mapped to `<DIRECTORY>/aerospike.conf`.
A full example: A full example:
docker run -tid -v <DIRECTORY>:/opt/aerospike/etc --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server --config-file /opt/aerospike/etc/aerospike.conf docker run -d -v <DIRECTORY>:/opt/aerospike/etc --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server asd --foreground --config-file /opt/aerospike/etc/aerospike.conf
## access-address Configuration ## access-address Configuration
@ -43,14 +39,12 @@ In order for Aerospike to properly broadcast its address to the cluster or appli
To specify **access-address** in aerospike.conf: To specify **access-address** in aerospike.conf:
network { network {
service { service {
address any # Listening IP Address address any # Listening IP Address
port 3000 # Listening Port port 3000 # Listening Port
access-address 192.168.1.100 # IP Address to be used by applications access-address 192.168.1.100 # IP Address to be used by applications and other nodes in the cluster.
# and other nodes in the cluster. }
} ...
...
## Persistent Data Directory ## Persistent Data Directory
@ -62,8 +56,7 @@ Where `<DIRECTORY>` is the path to a directory containing your data files.
A full example: A full example:
docker run -tid -v <DIRECTORY>:/opt/aerospike/data --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server docker run -d -v <DIRECTORY>:/opt/aerospike/data --name aerospike -p 3000:3000 -p 3001:3001 -p 3002:3002 -p 3003:3003 aerospike/aerospike-server
## Clustering ## Clustering
@ -73,30 +66,5 @@ Aerospike recommends using multicast clustering whenever possible, however, we a
Mesh networking requires setting up links between each node in the cluster. This can be achieved in two ways: Mesh networking requires setting up links between each node in the cluster. This can be achieved in two ways:
1. Define a configuration for each node in the cluster, as defined in [Network Heartbeat Configuration](http://www.aerospike.com/docs/operations/configure/network/heartbeat/#mesh-unicast-heartbeat). 1. Define a configuration for each node in the cluster, as defined in [Network Heartbeat Configuration](http://www.aerospike.com/docs/operations/configure/network/heartbeat/#mesh-unicast-heartbeat).
2. Use `asinfo` to send the `tip` command, to make the node aware of another node, as defined in [tip command in asinfo](http://www.aerospike.com/docs/tools/asinfo/#tip).
2. Use `asinfo` to send the `tip` command, to make the node aware of another node, as defined in [tip command in asinfo](http://www.aerospike.com/docs/tools/asinfo/#tip).
# Supported Docker versions
This image is officially supported on Docker version 1.4.1.
Support for older versions (down to 1.0) is provided on a best-effort basis.
# User Feedback
## Issues
If you have any problems with or questions about this image, please contact us on the [Aerospike Forums](discuss.aerospike.com) or through a [GitHub issue](https://github.com/aerospike/aerospike-server.docker/issues).
## Contributing
You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.
Before you start to code, we recommend discussing your plans on the [Aerospike Forums](discuss.aerospike.com) or through a [GitHub issue](https://github.com/aerospike/aerospike-server.docker/issues), especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

12
aerospike/license.md
View File

@ -1,13 +1,5 @@
Copyright 2014-2015 Aerospike, Inc. Copyright 2014-2015 Aerospike, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0 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.
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.