This is an automated email from the ASF dual-hosted git repository.
weichiu pushed a commit to branch HDDS-9225-website-v2
in repository https://gitbox.apache.org/repos/asf/ozone-site.git
The following commit(s) were added to refs/heads/HDDS-9225-website-v2 by this
push:
new d1c1d7432 HDDS-14485. [Website v2] [Docs] [Administrator Guide]
Configuration Files (#283)
d1c1d7432 is described below
commit d1c1d74325a57352c417b744a63544d2438d77d1
Author: Wei-Chiu Chuang <[email protected]>
AuthorDate: Tue Jan 27 00:48:22 2026 -0800
HDDS-14485. [Website v2] [Docs] [Administrator Guide] Configuration Files
(#283)
---
.../01-basic/01-configuration-files.md | 44 +++++++++++++++++++++-
1 file changed, 42 insertions(+), 2 deletions(-)
diff --git
a/docs/05-administrator-guide/02-configuration/01-basic/01-configuration-files.md
b/docs/05-administrator-guide/02-configuration/01-basic/01-configuration-files.md
index efe1346d1..5f18db049 100644
---
a/docs/05-administrator-guide/02-configuration/01-basic/01-configuration-files.md
+++
b/docs/05-administrator-guide/02-configuration/01-basic/01-configuration-files.md
@@ -1,5 +1,45 @@
# Configuration Files
-**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
+Apache Ozone services are configured using XML files. These configuration
files define various parameters that control the behavior of Ozone Managers
(OM), Storage Container Managers (SCM), Datanodes (DN), and other related
services like S3 Gateway and HttpFS.
-Document `ozone-site.xml` and `core-site.xml` configuration files for the
Ozone server, their basic format, and where they are read from. Specific config
keys will be documented in later sections.
+The primary configuration files for an Ozone server are:
+
+- **`ozone-site.xml`**: This file contains Ozone-specific configurations. Most
of the parameters you'll set for your Ozone cluster will reside here.
+- **`core-site.xml`**: This file contains core configurations that are common
across various services that integrate with or run alongside Ozone. Parameters
related to file system client behavior, I/O settings, and some security aspects
might be defined here.
+- **`httpfs-site.xml`**: This file is specific to the HttpFS service, which
provides a REST HTTP gateway to Ozone. It contains configurations related to
the HttpFS server, such as its port, authentication settings, and proxy user
definitions.
+
+## Basic Format
+
+All these configuration files follow a standard XML format, consisting of a
`<configuration>` root element, inside which each configuration property is
defined using `<property>` tags. Each `<property>` tag contains a `<name>` tag
for the property key and a `<value>` tag for its value.
+
+Example:
+
+```xml
+<?xml version="1.0"?>
+<?xml-stylesheet type="text/xsl" href="configuration.xsl"?>
+<configuration>
+ <property>
+ <name>ozone.om.address</name>
+ <value>0.0.0.0:9862</value>
+ </property>
+ <property>
+ <name>ozone.scm.client.address</name>
+ <value>0.0.0.0:9850</value>
+ </property>
+</configuration>
+```
+
+## Where Configuration Files Are Read From
+
+Ozone services read their configuration from files typically located in a
designated `conf` directory. When running Ozone directly, this usually means
the `etc/hadoop` directory within your Ozone installation path. The
`OZONE_CONF_DIR` environment variable can be used to specify a custom location
for this directory.
+
+The loading order and precedence of configuration files are as follows:
+
+1. **Default Configurations**: Each service has a set of default
configurations embedded within its JAR files (e.g.,
[`ozone-default.xml`](https://github.com/apache/ozone/blob/master/hadoop-hdds/common/src/main/resources/ozone-default.xml)).
These provide baseline settings.
+2. **Site-Specific Configurations**: Files like `ozone-site.xml`,
`core-site.xml`, and `httpfs-site.xml` located in the `conf` directory override
the default settings. These are where administrators customize the cluster's
behavior.
+
+For example, if Ozone is installed at `/opt/ozone`, the configuration files
would typically be located at `/opt/ozone/etc/hadoop/`.
+
+When deploying with Docker or Kubernetes, the configuration files are usually
mounted into the container's designated configuration directory (e.g.,
`/opt/ozone/etc/hadoop` inside a Docker container).
+
+Specific configuration keys will be documented in later sections.
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
