Browse Source

Docs: Added tables for directory locations for deb+rpm and zip+tar.gz installs

Closes #6508
Mark Walkom 11 years ago
parent
commit
d75aabc5aa
1 changed files with 55 additions and 12 deletions
  1. 55 12
      docs/reference/setup/dir-layout.asciidoc

+ 55 - 12
docs/reference/setup/dir-layout.asciidoc

@@ -3,23 +3,19 @@
 
 The directory layout of an installation is as follows:
 
-[cols="<,<,<,<",options="header",]
+[cols="<h,<,<m,<m",options="header",]
 |=======================================================================
-|Type |Description |Default Location |Setting
-|*home* |Home of elasticsearch installation | | `path.home`
+| Type | Description | Default Location | Setting
+| home | Home of elasticsearch installation. | | path.home
 
-|*bin* |Binary scripts including `elasticsearch` to start a node | `{path.home}/bin` |
+| bin | Binary scripts including `elasticsearch` to start a node. | {path.home}/bin | | conf | Configuration files including `elasticsearch.yml` | {path.home}/config | path.conf
 
-|*conf* |Configuration files including `elasticsearch.yml` |`{path.home}/config` |`path.conf`
+| data | The location of the data files of each index / shard allocated
+on the node. Can hold multiple locations. | {path.home}/data| path.data
 
-|*data* |The location of the data files of each index / shard allocated
-on the node. Can hold multiple locations. |`{path.home}/data`|`path.data`
+| logs | Log files location. | {path.home}/logs | path.logs
 
-|*work* |Temporal files that are used by different nodes. |`{path.home}/work` |`path.work`
-
-|*logs* |Log files location |`{path.home}/logs` |`path.logs`
-
-|*plugins* |Plugin files location. Each plugin will be contained in a subdirectory. |`{path.home}/plugins` |`path.plugins`
+| plugins | Plugin files location. Each plugin will be contained in a subdirectory. | {path.home}/plugins | path.plugins
 |=======================================================================
 
 The multiple data locations allows to stripe it. The striping is simple,
@@ -45,3 +41,50 @@ Or the in an array format:
 ----------------------------------------
 path.data: ["/mnt/first", "/mnt/second"]
 ----------------------------------------
+
+
+[float]
+[[Default Paths]]
+=== Default Paths
+
+Below are the default paths that elasticsearch will use, if not explictly changed.
+
+==== deb and rpm
+[cols="<h,<,<m,<m",options="header",]
+|=======================================================================
+| Type | Description | Location Debian/Ubuntu | Location RHEL/CentOS
+| home | Home of elasticsearch installation. | /usr/share/elasticsearch | /usr/share/elasticsearch
+
+| bin | Binary scripts including `elasticsearch` to start a node. | /usr/share/elasticsearch/bin | /usr/share/elasticsearch/bin
+
+| conf | Configuration files `elasticsearch.yml` and `logging.yml`. | /etc/elasticsearch | /etc/elasticsearch
+
+| conf | Environment variables including heap size, file descriptors. | /etc/default/elasticseach | /etc/sysconfig/elasticsearch
+
+| data | The location of the data files of each index / shard allocated
+on the node. | /var/lib/elasticsearch/data | /var/lib/elasticsearch
+
+| logs | Log files location | /var/log/elasticsearch | /var/log/elasticsearch
+
+| plugins | Plugin files location. Each plugin will be contained in a subdirectory. | /usr/share/elasticsearch/plugins | /usr/share/elasticsearch/plugins
+|=======================================================================
+
+==== zip and tar.gz
+[cols="<h,<,<m",options="header",]
+|=======================================================================
+| Type | Description | Location
+| home | Home of elasticsearch installation | {extract.path}
+
+| bin | Binary scripts including `elasticsearch` to start a node | {extract.path}/bin
+
+| conf | Configuration files `elasticsearch.yml` and `logging.yml` | {extract.path}/config
+
+| conf | Environment variables including heap size, file descriptors | {extract.path}/config
+
+| data | The location of the data files of each index / shard allocated
+on the node | {extract.path}/data
+
+| logs | Log files location | {extract.path}/logs
+
+| plugins | Plugin files location. Each plugin will be contained in a subdirectory | {extract.path}/plugins
+|=======================================================================