Installing Knox Gateway with the platform-specific installers creates the following directories:
/usr/lib/knoxis the$gateway_homedirectory, see table below./var/log/knoxcontains the output files from the Knox Gateway./var/run/knoxcontains the Process ID (PID) for the currently running Knox Gateway.
The table below describes the files and directories in
$gateway_home:
Table 2.1. Gateway Home Directory Contents
| Directory/file name | Description |
|---|---|
conf | Contains global gateway configuration files. |
bin | Contains the executable shell scripts, batch files, and JARs for clients and servers. |
deployments | Contains cluster topology descriptor files that define Hadoop clusters, see Configure Cluster Topologies. |
lib | Contains the JARs for all the components that make up the gateway. |
dep | Contains the JARs for all of the components upon which the gateway depends. |
ext | A directory where user supplied extension JARs can be placed to extends the gateways functionality. |
samples | Contains a number of samples that can be used to explore the functionality of the gateway. |
templates | Contains default configuration files that can be copied and customized. |
README | Provides basic information about the Apache Knox Gateway. |
ISSUES | Describes significant known issues. |
CHANGES | Enumerates the changes between releases. |
LICENSE | Documents the license under which this software is provided. |
NOTICE | Documents required attribution notices for included dependencies. |
DISCLAIMER | Documents that this release is from a project undergoing incubation at Apache. |
Hortonworks recommends creating a specific user, such as knox, to run and
secure the gateway. The following outlines the recommended ownership when running the
Knox Gateway:
/usr/lib/knox($gateway_home): Contains the installed application files (i.e. binaries). Owned by root and read-only for others./etc/knox: Contains the gateway configuration files. Owned by root and read-only for others./var/lib/knox/data: Contains gateway security, cluster deployments, and auditing information; the gateway writes to this directory at runtime. Owned, writable and readable by theknoxuser./var/log/knox: Contains gateway log files. Owned and writableby theknoxuser and read-only for others./var/run/knox: Contains the gateway PID files. Owned and writableby theknoxuser and read-only for others.
![[Note]](../common/images/admon/note.png) | Note |
|---|---|
For instructions on setting up security, such as Kerberos and SSL configuration, see Configuring Knox Gateway Security. |
