This is an automated email from the ASF dual-hosted git repository.
adoroszlai 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 c3b3b3a4 HDDS-10254. Add GitHub Actions check for Markdown style. (#81)
c3b3b3a4 is described below
commit c3b3b3a4c72d260522a450557ba7b24d9fbaca6f
Author: Ethan Rose <[email protected]>
AuthorDate: Sat Mar 2 09:23:41 2024 -0800
HDDS-10254. Add GitHub Actions check for Markdown style. (#81)
---
.github/scripts/markdownlint.sh | 23 ++++
.github/workflows/static.yml | 19 +++
.markdownlint.yaml | 136 +++++++++++++++++++
.markdownlintignore | 19 +++
CONTRIBUTING.md | 144 +++++++++++----------
README.md | 1 +
docs/01-overview.md | 1 -
docs/03-core-concepts/01-architecture.md | 1 -
.../02-replication/01-storage-containers.md | 1 -
.../02-replication/02-write-pipelines.md | 1 -
.../04-security/01-authentication/01-kerberos.md | 1 -
.../04-security/01-authentication/02-knox.md | 1 -
.../01-authentication/03-s3-credentials.md | 1 -
docs/03-core-concepts/05-configuration-files.md | 2 +-
.../01-installation/03-installing-binaries.md | 1 +
.../01-network/02-storage-container-manager.md | 1 -
.../01-basic/01-network/03-datanode.md | 1 -
.../01-basic/01-network/04-recon.md | 1 -
.../01-basic/01-network/05-s3-gateway.md | 1 -
.../02-directories/02-storage-container-manager.md | 1 -
.../01-basic/02-directories/03-datanode.md | 1 -
.../01-basic/02-directories/04-recon.md | 1 -
.../03-security/01-administrators.md | 3 +-
.../02-configuration/03-security/01-kerberos.md | 1 -
.../04-encryption/01-network-encryption/02-grpc.md | 4 +-
.../03-operations/02-upgrade-and-downgrade.md | 1 -
.../02-storage-container-manager.md | 1 -
.../03-datanodes.md | 2 -
.../02-storage-container-manager.md | 1 -
.../04-disk-replacement/03-datanodes.md | 1 -
.../03-operations/04-disk-replacement/04-recon.md | 1 -
.../03-operations/05-balancing-datanodes.md | 1 -
.../03-operations/09-observability/01-cli.md | 1 -
.../03-operations/09-observability/03-web-uis.md | 2 -
docs/06-troubleshooting/01-startup.md | 1 -
docs/06-troubleshooting/02-safemode.md | 1 -
docs/06-troubleshooting/03-read-write.md | 1 -
docs/06-troubleshooting/04-delete.md | 1 -
docs/06-troubleshooting/05-recon.md | 1 -
docs/06-troubleshooting/06-performance.md | 1 -
.../07-integrations/01-placeholder.md | 1 -
.../08-security/01-certificates.md | 1 -
.../08-security/02-authentication.md | 1 -
docs/06-troubleshooting/09-upgrade-downgrade.md | 1 -
.../10-decommission-maintenance.md | 1 -
docs/06-troubleshooting/11-write-pipelines.md | 1 -
docs/06-troubleshooting/12-storage-containers.md | 1 -
docs/06-troubleshooting/13-ratis.md | 1 -
docs/06-troubleshooting/14-rocksdb.md | 1 -
.../01-ozone-manager/02-rocksdb-schema.md | 1 -
.../01-ozone-manager/03-in-memory-storage.md | 1 -
.../01-ozone-manager/04-startup-sequence.md | 2 -
.../01-components/01-ozone-manager/05-roles.md | 1 -
.../01-ozone-manager/06-write-request-flow.md | 1 -
.../01-ozone-manager/07-read-request-flow.md | 1 -
.../02-storage-container-manager/01-disk-layout.md | 1 -
.../02-rocksdb-schema.md | 1 -
.../03-in-memory-storage.md | 1 -
.../04-startup-sequence.md | 1 -
.../02-storage-container-manager/05-roles.md | 2 +-
.../06-admin-write-request-flow.md | 1 -
.../07-admin-read-request-flow.md | 1 -
.../01-components/03-datanode/01-disk-layout.md | 1 -
.../01-components/03-datanode/02-rocksdb-schema.md | 1 -
.../03-datanode/03-in-memory-storage.md | 1 -
.../03-datanode/04-startup-sequence.md | 1 -
.../03-datanode/06-write-request-flow.md | 1 -
.../03-datanode/07-read-request-flow.md | 1 -
.../01-components/04-recon/01-disk-layout.md | 1 -
.../01-components/04-recon/02-rocksdb-schema.md | 1 -
.../01-components/04-recon/03-sql-schema.md | 1 -
.../01-components/04-recon/04-in-memory-storage.md | 1 -
.../01-components/04-recon/05-startup-sequence.md | 1 -
.../04-recon/06-syncing-data-from-om.md | 1 -
.../04-recon/07-syncing-data-from-scm.md | 1 -
.../04-recon/08-syncing-data-from-datanodes.md | 1 -
.../01-components/05-s3-gateway/01-overview.md | 1 -
.../01-components/05-s3-gateway/02-request-flow.md | 1 -
.../01-components/06-client/01-startup-sequence.md | 1 -
.../06-client/02-in-memory-storage.md | 1 -
.../02-data-operations/01-write.md | 22 ++--
.../02-data-operations/02-read.md | 14 +-
.../02-data-operations/03-delete.md | 4 +-
.../02-data-operations/04-hsync.md | 1 -
.../03-data-integrity/01-checksums.md | 1 -
.../03-data-integrity/02-container-scanner.md | 1 -
.../03-data-integrity/03-volume-scanner.md | 1 -
.../01-write-pipelines/01-overview.md | 1 -
.../01-write-pipelines/02-types.md | 1 -
.../01-write-pipelines/03-states.md | 1 -
.../01-write-pipelines/04-reports.md | 1 -
.../01-write-pipelines/05-creation.md | 1 -
.../01-write-pipelines/06-persistence.md | 1 -
.../01-write-pipelines/07-destruction.md | 1 -
.../02-containers/01-overview.md | 1 -
.../02-data-replication/02-containers/02-types.md | 1 -
.../02-data-replication/02-containers/03-states.md | 1 -
.../02-containers/04-reports.md | 1 -
.../02-containers/05-creation.md | 1 -
.../02-containers/06-persistence.md | 1 -
.../02-containers/07-destruction.md | 1 -
.../02-containers/08-replication.md | 2 +-
.../02-containers/09-offline-reconstruction.md | 1 -
.../07-system-internals/05-security/01-kerberos.md | 1 -
.../05-security/02-symmetric-encryption.md | 1 -
docs/07-system-internals/05-security/03-tokens.md | 1 -
.../05-security/04-certificates.md | 1 -
docs/07-system-internals/05-security/05-tls.md | 1 -
docs/07-system-internals/05-security/06-sasl.md | 1 -
.../05-security/07-s3-credentials.md | 1 -
.../06-network-protocols/01-overview.md | 3 +-
.../06-network-protocols/02-client.md | 23 ++--
.../06-network-protocols/03-server.md | 21 ++-
.../07-features/01-filesystem-optimization.md | 1 -
.../07-features/03-bucket-snapshots.md | 1 -
.../07-features/04-erasure-coding.md | 1 -
.../07-features/05-ratis-streaming.md | 1 -
.../01-build/01-prerequisites.md | 2 +-
docs/08-developer-guide/01-build/02-maven.md | 4 +-
.../01-build/04-docker-images.md | 4 +-
.../08-developer-guide/02-run/02-docker-compose.md | 4 +-
.../03-test/02-integration-tests.md | 1 -
.../03-test/04-continuous-integration.md | 2 +-
.../04-project/01-branches-and-tags.md | 3 +-
.../04-project/02-release-guide.md | 58 ++++++---
package.json | 3 +-
pnpm-lock.yaml | 89 ++++++++++++-
src/pages/community/communication-channels.md | 1 +
src/pages/community/how-to-contribute.md | 5 +-
src/pages/download.md | 2 +-
src/pages/release-notes/1.0.0.md | 1 -
src/pages/release-notes/1.1.0.md | 1 -
src/pages/release-notes/1.2.1.md | 1 -
src/pages/release-notes/1.3.0.md | 1 -
134 files changed, 461 insertions(+), 266 deletions(-)
diff --git a/.github/scripts/markdownlint.sh b/.github/scripts/markdownlint.sh
new file mode 100755
index 00000000..4d010fa4
--- /dev/null
+++ b/.github/scripts/markdownlint.sh
@@ -0,0 +1,23 @@
+#!/usr/bin/env sh
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+
+
+root="$(git rev-parse --show-toplevel)"
+
+pnpm markdownlint "$root"
+
diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml
index 98c282de..7cc1e834 100644
--- a/.github/workflows/static.yml
+++ b/.github/workflows/static.yml
@@ -64,3 +64,22 @@ jobs:
if: ${{ failure() }}
run: |
cat ${{ env.resource_dir }}/spelling_tips.md >> $GITHUB_STEP_SUMMARY
+ lint-markdown:
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout project
+ uses: actions/checkout@v4
+ - name: Enable corepack
+ run: |
+ corepack enable
+ - name: Use Node.js ${{ env.node_version }}
+ uses: actions/setup-node@v4
+ with:
+ node-version: ${{ env.node_version }}
+ cache: pnpm
+ - name: Install pnpm dependencies
+ run: pnpm install --dev
+ - name: Run markdownlint
+ working-directory: ${{ env.script_dir }}
+ run: |
+ ./markdownlint.sh
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
new file mode 100644
index 00000000..4d3a44dd
--- /dev/null
+++ b/.markdownlint.yaml
@@ -0,0 +1,136 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+
+# This file extends the defaults present in
https://github.com/DavidAnson/markdownlint/blob/main/schema/.markdownlint.yaml
+
+# Only - (dash) character is allowed for bullet lists.
+heading-increment:
+ style: dash
+
+line-length:
+ # No line length requirement for general text.
+ line_length: -1
+ # For code, match Ozone's line length.
+ code_block_line_length: 120
+ # Use shorter headings to keep the minimap on the right legible.
+ heading_block_line_length: 80
+
+# Numbered lists must use numbers in ascending order.
+ol-prefix:
+ style: ordered
+
+# Disallow inline html except for these allowed elements.
+# If new elements are required for some use cases, this list can be expanded.
+no-inline-html:
+ allowed_elements:
+ - br
+ - Tabs
+ - TabItem
+
+# Allow bare URLs since wrapping URLs in <> is invalid mdx.
+no-bare-urls: false
+
+# Horizontal rule.
+hr-style:
+ style: ---
+
+# Enforce consistent capitalization.
+# Use markdownlint instead of cspell to enforce capitalization since
markdownlint is aware of code blocks within
+# markdown, for which these rules do not apply.
+proper-names:
+ # Do not enforced capitalization checks inside code blocks.
+ code_blocks: false
+ # HTML elements may be rendering user facing text with these words in them.
+ html_elements: true
+ # Enforce consistent capitalization for these words:
+ names:
+ # Ozone components:
+ - OM
+ - Ozone Manager
+ - SCM
+ - Storage Container Manager
+ - Recon
+ - Datanode
+ - Datanodes
+ - S3 Gateway
+ - HDDS
+ # Acronyms:
+ - FSO
+ - OBS
+ - ofs
+ - HttpFS
+ - CLI
+ - RPC
+ - EC
+ - SPNEGO
+ - SASL
+ - TLS
+ - mTLS
+ - SSL
+ - X.509
+ - REST API
+ - JSON
+ - .json
+ - YAML
+ - .yaml
+ - XML
+ - .xml
+ # Other systems:
+ - gRPC
+ - RocksDB
+ - Jira
+ - Java
+ - Maven
+ - GPG
+ - Netty
+ - Docker Compose
+ - Docker
+ - pnpm
+ - S3
+ - Hadoop
+ # Enforce capitalization for these words only when they are used in
sentences (surrounded by spaces).
+ # Other uses in repo names or links like
[apache/ozone](https://github.com/apache/ozone) are ok.
+ - " Ratis "
+ - " Ozone "
+ - " Apache "
+ - " ASF "
+ - " HTTP "
+ - " HTTPS "
+
+# Indentation should not be used to indicate a multi-line code block.
+code-block-style:
+ style: fenced
+
+# Only allow ``` to define multi-line code blocks.
+code-fence-style:
+ style: backtick
+
+# Use asterisks for italics.
+emphasis-style:
+ style: asterisk
+
+# Use double asterisks for bold.
+strong-style:
+ style: asterisk
+
+# Disable inline links with the same URL, like
[www.example.com](www.example.com)
+link-image-style:
+ url_inline: false
+
+# Use pipes on both ends of every line in a table.
+table-pipe-style:
+ style: leading_and_trailing
diff --git a/.markdownlintignore b/.markdownlintignore
new file mode 100644
index 00000000..3f9d4c8d
--- /dev/null
+++ b/.markdownlintignore
@@ -0,0 +1,19 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you 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.
+
+build
+node_modules
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 7e6c31ef..7211f18a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -14,7 +14,7 @@ This document summarizes the contribution process.
- **Tests**: [HDDS-9601](https://issues.apache.org/jira/browse/HDDS-9601) will
implement a basic set of tests to run as part of CI for the website, but you
can help expand or improve them.
-- **Tools**: You can submit improvements to how we use various tools like
pnpm, docker, and Dependabot that are used in the development of the website.
+- **Tools**: You can submit improvements to how we use various tools like
pnpm, Docker, and Dependabot that are used in the development of the website.
## Filing Jira Issues
@@ -75,10 +75,9 @@ Docusaurus docs are written in markdown. All standard
markdown formatting can be
- [Tabs](https://docusaurus.io/docs/markdown-features/tabs) can show multiple
possibilities succinctly.
- Standard Markdown [Code
blocks](https://docusaurus.io/docs/markdown-features/code-blocks) have extra
features, including:
- -
[Titles](https://docusaurus.io/docs/markdown-features/code-blocks#code-title)
- - [Optional line
numbers](https://docusaurus.io/docs/markdown-features/code-blocks#line-numbering)
- - [Multi-language
tabs](https://docusaurus.io/docs/markdown-features/code-blocks#multi-language-support-code-blocks)
-
+ -
[Titles](https://docusaurus.io/docs/markdown-features/code-blocks#code-title)
+ - [Optional line
numbers](https://docusaurus.io/docs/markdown-features/code-blocks#line-numbering)
+ - [Multi-language
tabs](https://docusaurus.io/docs/markdown-features/code-blocks#multi-language-support-code-blocks)
- [Admonitions](https://docusaurus.io/docs/markdown-features/admonitions)
(note, tip, info. warning, danger) optionally with [custom
titles](https://docusaurus.io/docs/markdown-features/admonitions#specifying-title).
@@ -93,7 +92,7 @@ Docusaurus docs are written in markdown. All standard
markdown formatting can be
Docusaurus provides many options for laying out documentation pages and their
metadata. The following best practices are followed by this repo, and some may
be enforced by CI checks once HDDS-9601 is complete.
- [Number
prefixes](https://docusaurus.io/docs/sidebar/autogenerated#using-number-prefixes)
should be used for all file and sidebar directory names to enforce their order
in the website and local editors.
- - Number prefixes will be automatically removed from links in the
Docusaurus build.
+ - Number prefixes will be automatically removed from links in the Docusaurus
build.
- [Category links](https://docusaurus.io/docs/sidebar/items#category-link)
should not be used. They make it easy to miss pages when looking at the sidebar
since it is unclear if they are just a dropdown or also contain documentation.
@@ -104,67 +103,72 @@ Docusaurus provides many options for laying out
documentation pages and their me
- Let Docusaurus automatically generate the page's title from its top level
markdown heading instead of using `title` in the frontmatter. This is different
from the sidebar label or URL slug.
- Use relative file paths for all links between pages.
- - This keeps page links pointing to the current version of the
documentation.
- - See [Markdown Links](https://docusaurus.io/docs/markdown-features/links)
in Docusaurus for more information.
+ - This keeps page links pointing to the current version of the documentation.
+ - See [Markdown Links](https://docusaurus.io/docs/markdown-features/links)
in Docusaurus for more information.
- Use short, succinct labels in the sidebar.
- - For example, the pages on bucket layouts may be organized as:
- ```
- ...
- Buckets
- ...
- Layouts
- File System Optimized (FSO)
- Object Store (OBS)
- ```
-
- - This avoids a verbose sidebar with duplicate information like this
example:
- ```
- ...
- Buckets
- ...
- Bucket Layouts
- File System Optimized Bucket Layout
- Object Store Bucket Layout
- ```
-
- - Sidebar labels are automatically generated from page titles. To use a
different sidebar label, use the `sidebar_label` property in the page's
frontmatter.
+ - For example, the pages on bucket layouts may be organized as:
+
+ ```text
+ ...
+ Buckets
+ ...
+ Layouts
+ File System Optimized (FSO)
+ Object Store (OBS)
+ ```
+
+ - This avoids a verbose sidebar with duplicate information like this example:
+
+ ```text
+ ...
+ Buckets
+ ...
+ Bucket Layouts
+ File System Optimized Bucket Layout
+ Object Store Bucket Layout
+ ```
+
+ - Sidebar labels are automatically generated from page titles. To use a
different sidebar label, use the `sidebar_label` property in the page's
frontmatter.
- Don't rely on Ozone specific acronyms in the sidebar. This makes docs
navigation more beginner friendly.
- - For example, the pages on bucket layouts may be organized as:
- ```
- ...
- Buckets
- ...
- Layouts
- File System Optimized (FSO)
- Object Store (OBS)
- ```
-
- - Which is easier for a new Ozone user to follow than this:
- ```
- ...
- Buckets
- ...
- Layouts
- FSO
- OBS
- ```
+ - For example, the pages on bucket layouts may be organized as:
+
+ ```text
+ ...
+ Buckets
+ ...
+ Layouts
+ File System Optimized (FSO)
+ Object Store (OBS)
+ ```
+
+ - Which is easier for a new Ozone user to follow than this:
+
+ ```text
+ ...
+ Buckets
+ ...
+ Layouts
+ FSO
+ OBS
+ ```
- Use descriptive page titles.
- - Pages may be linked directly from other sources and users should be able
to tell what the page is without looking at the sidebar.
- - There may also be multiple pages about the same topic, for example
Kerberos. Readers should be able to tell which aspect of Kerberos the page is
about to distinguish it from other pages.
+ - Pages may be linked directly from other sources and users should be able
to tell what the page is without looking at the sidebar.
+ - There may also be multiple pages about the same topic, for example
Kerberos. Readers should be able to tell which aspect of Kerberos the page is
about to distinguish it from other pages.
+
+ - For example, pages in the security configuration section may be organized
like this:
- - For example, pages in the security configuration section may be
organized like this:
- ```
- Configuration
+ ```text
+ Configuration
+ ...
+ Security
...
- Security
- ...
- Kerberos
- ```
+ Kerberos
+ ```
- - The sidebar label makes sense because it has the context of the parent
sidebar sections, however the Kerberos page should have a title like
"Configuring Kerberos" instead of just "Kerberos" like its sidebar label.
+ - The sidebar label makes sense because it has the context of the parent
sidebar sections, however the Kerberos page should have a title like
"Configuring Kerberos" instead of just "Kerberos" like its sidebar label.
#### Spelling
@@ -217,6 +221,7 @@ This file contains exact version information of all
dependencies required to bui
#### Version Pinning
*package.json* allows [version
specifiers](https://docs.npmjs.com/about-semantic-versioning#using-semantic-versioning-to-specify-update-types-your-package-can-accept)
to put limits on which versions are installed. The following specifiers are
currently used for the website:
+
- `~` means to allow all patch updates (last semantic versioning digit)
- `^` means to allow all minor version updates (second semantic versioning
digit)
- A version with no specifier means only the exact version declared in
*package.json* is allowed.
@@ -235,10 +240,10 @@ Currently all `@docusaurus/*` packages are pinned to an
exact version for websit
- **To update all packages to their latest versions allowed by package.json**:
`pnpm update`
- - This will update *package.json* to match the exact versions that were
installed, but this is for reference only. Exact version information still
comes from *pnpm-lock.yaml*
- - Version specifiers like `^` and `~` will not be modified, and the new
version will be the latest that still complies with the existing version
specifiers.
+ - This will update *package.json* to match the exact versions that were
installed, but this is for reference only. Exact version information still
comes from *pnpm-lock.yaml*
+ - Version specifiers like `^` and `~` will not be modified, and the new
version will be the latest that still complies with the existing version
specifiers.
- - This will update *pnpm-lock.yaml* to reflect the exact versions of all
top level and transitive dependencies installed.
+ - This will update *pnpm-lock.yaml* to reflect the exact versions of all top
level and transitive dependencies installed.
- **To update docusaurus to a specific version**:
@@ -246,9 +251,9 @@ Currently all `@docusaurus/*` packages are pinned to an
exact version for websit
2. Run `pnpm update '@docusaurus/*'` to update to the new version.
- - This should modify *pnpm-lock.yaml* with the exact versions of
docusaurus and its transitive dependencies that were installed.
+ - This should modify *pnpm-lock.yaml* with the exact versions of
docusaurus and its transitive dependencies that were installed.
- - If pnpm needed to update other top level dependencies when updating
docusaurus, this command may modify *package.json* as well.
+ - If pnpm needed to update other top level dependencies when updating
docusaurus, this command may modify *package.json* as well.
3. Commit *package.json* and *pnpm-lock.yaml* to git.
@@ -260,19 +265,20 @@ Docusaurus supports previewing the website locally. Below
are various options to
#### Option 1: Docker (Recommended)
-The project includes a `Dockerfile` and a `compose.yml` file to build and run
the website in a containerized environment. This creates a docker image called
`ozone-site` with all the dependencies included, and uses it to run the
[Docusaurus development
server](https://docusaurus.io/docs/installation#running-the-development-server).
+The project includes a `Dockerfile` and a `compose.yml` file to build and run
the website in a containerized environment. This creates a Docker image called
`ozone-site` with all the dependencies included, and uses it to run the
[Docusaurus development
server](https://docusaurus.io/docs/installation#running-the-development-server).
-1. Install [docker](https://docs.docker.com/engine/install/).
+1. Install [Docker](https://docs.docker.com/engine/install/).
-2. Install [docker compose](https://docs.docker.com/compose/install/).
+2. Install [Docker Compose](https://docs.docker.com/compose/install/).
3. Run `docker compose up` from the repository root.
- - **Note**: This will continue to use the last locally built version of the
`ozone-site-dev` image, which saves time on future runs.
- - Run `docker compose up --build` to rebuild the image and incorporate any
package dependency updates that may have been committed since the last build.
+
+ - **Note**: This will continue to use the last locally built version of
the `ozone-site-dev` image, which saves time on future runs.
+ - Run `docker compose up --build` to rebuild the image and incorporate
any package dependency updates that may have been committed since the last
build.
4. Preview the website at `localhost:3000` in your browser.
- - Any changes made in the repository will be reflected in the preview.
+ - Any changes made in the repository will be reflected in the preview.
5. Press `Ctrl+C` or run `docker compose down` to stop the preview.
diff --git a/README.md b/README.md
index 0cfe788b..923604f8 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,7 @@ You can preview the current state of the new website at
https://ozone-site-v2.st
## Contributing
Please see `CONTRIBUTING.md` for information about
+
- [Directory layout](./CONTRIBUTING.md#directory-layout)
- [Previewing the website
locally](./CONTRIBUTING.md#previewing-your-modifications-locally)
- [Filing Issues](./CONTRIBUTING.md#filing-jira-issues)
diff --git a/docs/01-overview.md b/docs/01-overview.md
index aec72baa..2808232c 100644
--- a/docs/01-overview.md
+++ b/docs/01-overview.md
@@ -10,4 +10,3 @@ slug: /
## What is Ozone?
## Features
-
diff --git a/docs/03-core-concepts/01-architecture.md
b/docs/03-core-concepts/01-architecture.md
index a80fa42e..8d88c62c 100644
--- a/docs/03-core-concepts/01-architecture.md
+++ b/docs/03-core-concepts/01-architecture.md
@@ -3,4 +3,3 @@
**TODO:** File a subtask under
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this
page or section.
A high level overview of Ozone's components and what they do.
-
diff --git a/docs/03-core-concepts/02-replication/01-storage-containers.md
b/docs/03-core-concepts/02-replication/01-storage-containers.md
index 9c627605..ff06a231 100644
--- a/docs/03-core-concepts/02-replication/01-storage-containers.md
+++ b/docs/03-core-concepts/02-replication/01-storage-containers.md
@@ -3,4 +3,3 @@
**TODO:** File a subtask under
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this
page or section.
Provide a high level summary of storage containers and their purpose.
Technically this is just for context and deep understanding is not required by
most users of the system. The System Internals section of the docs will have
much more details on containers.
-
diff --git a/docs/03-core-concepts/02-replication/02-write-pipelines.md
b/docs/03-core-concepts/02-replication/02-write-pipelines.md
index 733f283c..60731347 100644
--- a/docs/03-core-concepts/02-replication/02-write-pipelines.md
+++ b/docs/03-core-concepts/02-replication/02-write-pipelines.md
@@ -3,4 +3,3 @@
**TODO:** File a subtask under
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this
page or section.
Provide a high level summary of write pipelines and their purpose. Technically
this is just for context and deep understanding is not required by most users
of the system. The System Internals section of the docs will have much more
details on write pipelines.
-
diff --git a/docs/03-core-concepts/04-security/01-authentication/01-kerberos.md
b/docs/03-core-concepts/04-security/01-authentication/01-kerberos.md
index cb0d0931..7661225a 100644
--- a/docs/03-core-concepts/04-security/01-authentication/01-kerberos.md
+++ b/docs/03-core-concepts/04-security/01-authentication/01-kerberos.md
@@ -7,4 +7,3 @@ sidebar_label: Kerberos
**TODO:** File a subtask under
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this
page or section.
## Using SPNEGO to Authenticate with Kerberos over HTTP
-
diff --git a/docs/03-core-concepts/04-security/01-authentication/02-knox.md
b/docs/03-core-concepts/04-security/01-authentication/02-knox.md
index 0afaa222..dd8718b3 100644
--- a/docs/03-core-concepts/04-security/01-authentication/02-knox.md
+++ b/docs/03-core-concepts/04-security/01-authentication/02-knox.md
@@ -5,4 +5,3 @@ sidebar_label: Apache Knox
# Authenticating with Apache Knox
**TODO:** File a subtask under
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this
page or section.
-
diff --git
a/docs/03-core-concepts/04-security/01-authentication/03-s3-credentials.md
b/docs/03-core-concepts/04-security/01-authentication/03-s3-credentials.md
index c32902c0..2cd03d63 100644
--- a/docs/03-core-concepts/04-security/01-authentication/03-s3-credentials.md
+++ b/docs/03-core-concepts/04-security/01-authentication/03-s3-credentials.md
@@ -5,4 +5,3 @@ sidebar_label: S3 Credentials
# Authenticating with S3 Credentials
**TODO:** File a subtask under
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this
page or section.
-
diff --git a/docs/03-core-concepts/05-configuration-files.md
b/docs/03-core-concepts/05-configuration-files.md
index d42b7044..37314dbe 100644
--- a/docs/03-core-concepts/05-configuration-files.md
+++ b/docs/03-core-concepts/05-configuration-files.md
@@ -3,9 +3,9 @@
**TODO:** File a subtask under
[HDDS-9857](https://issues.apache.org/jira/browse/HDDS-9857) and complete this
page or section.
Covers what configuration files exist in the system, their basic format, and
where they are read from. Does not cover specific config keys to use.
+
- ozone-site.xml
- core-site.xml
- application log4j
- audit log4j
- client log4j
-
diff --git
a/docs/05-administrator-guide/01-installation/03-installing-binaries.md
b/docs/05-administrator-guide/01-installation/03-installing-binaries.md
index 1516632b..6148f422 100644
--- a/docs/05-administrator-guide/01-installation/03-installing-binaries.md
+++ b/docs/05-administrator-guide/01-installation/03-installing-binaries.md
@@ -3,5 +3,6 @@
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
To obtain binaries, link either:
+
- Downloads page to get the released tarball
- Developer guide to build from source.
diff --git
a/docs/05-administrator-guide/02-configuration/01-basic/01-network/02-storage-container-manager.md
b/docs/05-administrator-guide/02-configuration/01-basic/01-network/02-storage-container-manager.md
index 52e2e02f..ed022ef4 100644
---
a/docs/05-administrator-guide/02-configuration/01-basic/01-network/02-storage-container-manager.md
+++
b/docs/05-administrator-guide/02-configuration/01-basic/01-network/02-storage-container-manager.md
@@ -5,4 +5,3 @@ sidebar_label: Storage Container Manager
# Network Configuration for Storage Container Manager
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/02-configuration/01-basic/01-network/03-datanode.md
b/docs/05-administrator-guide/02-configuration/01-basic/01-network/03-datanode.md
index 7b2df75e..11083991 100644
---
a/docs/05-administrator-guide/02-configuration/01-basic/01-network/03-datanode.md
+++
b/docs/05-administrator-guide/02-configuration/01-basic/01-network/03-datanode.md
@@ -5,4 +5,3 @@ sidebar_label: Datanodes
# Network Configuration for Datanodes
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/02-configuration/01-basic/01-network/04-recon.md
b/docs/05-administrator-guide/02-configuration/01-basic/01-network/04-recon.md
index 03c519eb..a4db9649 100644
---
a/docs/05-administrator-guide/02-configuration/01-basic/01-network/04-recon.md
+++
b/docs/05-administrator-guide/02-configuration/01-basic/01-network/04-recon.md
@@ -5,4 +5,3 @@ sidebar_label: Recon
# Network Configuration for Recon
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/02-configuration/01-basic/01-network/05-s3-gateway.md
b/docs/05-administrator-guide/02-configuration/01-basic/01-network/05-s3-gateway.md
index 5b070f9a..12cfc6ed 100644
---
a/docs/05-administrator-guide/02-configuration/01-basic/01-network/05-s3-gateway.md
+++
b/docs/05-administrator-guide/02-configuration/01-basic/01-network/05-s3-gateway.md
@@ -5,4 +5,3 @@ sidebar_label: S3 Gateways
# Network Configuration for S3 Gateways
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/02-configuration/01-basic/02-directories/02-storage-container-manager.md
b/docs/05-administrator-guide/02-configuration/01-basic/02-directories/02-storage-container-manager.md
index cd968ebf..181783b8 100644
---
a/docs/05-administrator-guide/02-configuration/01-basic/02-directories/02-storage-container-manager.md
+++
b/docs/05-administrator-guide/02-configuration/01-basic/02-directories/02-storage-container-manager.md
@@ -5,4 +5,3 @@ sidebar_label: Storage Container Manager
# Directory Configurations for Storage Container Manager
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/02-configuration/01-basic/02-directories/03-datanode.md
b/docs/05-administrator-guide/02-configuration/01-basic/02-directories/03-datanode.md
index fe2048fd..a6778217 100644
---
a/docs/05-administrator-guide/02-configuration/01-basic/02-directories/03-datanode.md
+++
b/docs/05-administrator-guide/02-configuration/01-basic/02-directories/03-datanode.md
@@ -5,4 +5,3 @@ sidebar_label: Datanodes
# Directory Configurations for Datanodes
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/02-configuration/01-basic/02-directories/04-recon.md
b/docs/05-administrator-guide/02-configuration/01-basic/02-directories/04-recon.md
index 3fe4c3c5..c408fe23 100644
---
a/docs/05-administrator-guide/02-configuration/01-basic/02-directories/04-recon.md
+++
b/docs/05-administrator-guide/02-configuration/01-basic/02-directories/04-recon.md
@@ -5,4 +5,3 @@ sidebar_label: Recon
# Directory Configurations for Recon
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/02-configuration/03-security/01-administrators.md
b/docs/05-administrator-guide/02-configuration/03-security/01-administrators.md
index 61ba97e8..8d7be214 100644
---
a/docs/05-administrator-guide/02-configuration/03-security/01-administrators.md
+++
b/docs/05-administrator-guide/02-configuration/03-security/01-administrators.md
@@ -6,5 +6,4 @@ sidebar_label: Administrators
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-Ozone has many configurations for administrators. Document their default
values, and usage of ozone admin users and groups, recon admin users and
groups, and s3 admin user and groups.
-
+Ozone has many configurations for administrators. Document their default
values, and usage of Ozone admin users and groups, Recon admin users and
groups, and S3 admin user and groups.
diff --git
a/docs/05-administrator-guide/02-configuration/03-security/01-kerberos.md
b/docs/05-administrator-guide/02-configuration/03-security/01-kerberos.md
index 0e673abd..1e735013 100644
--- a/docs/05-administrator-guide/02-configuration/03-security/01-kerberos.md
+++ b/docs/05-administrator-guide/02-configuration/03-security/01-kerberos.md
@@ -9,4 +9,3 @@ sidebar_label: Kerberos
## Configuring SPNEGO
This section will probably be pretty short so we can combine it with the
Kerberos section.
-
diff --git
a/docs/05-administrator-guide/02-configuration/03-security/04-encryption/01-network-encryption/02-grpc.md
b/docs/05-administrator-guide/02-configuration/03-security/04-encryption/01-network-encryption/02-grpc.md
index 3796ea9c..3ed48496 100644
---
a/docs/05-administrator-guide/02-configuration/03-security/04-encryption/01-network-encryption/02-grpc.md
+++
b/docs/05-administrator-guide/02-configuration/03-security/04-encryption/01-network-encryption/02-grpc.md
@@ -1,7 +1,7 @@
---
-sidebar_label: GRPC
+sidebar_label: gRPC
---
-# Configuring GRPC With TLS
+# Configuring gRPC With TLS
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
diff --git
a/docs/05-administrator-guide/03-operations/02-upgrade-and-downgrade.md
b/docs/05-administrator-guide/03-operations/02-upgrade-and-downgrade.md
index 8185117c..1354277f 100644
--- a/docs/05-administrator-guide/03-operations/02-upgrade-and-downgrade.md
+++ b/docs/05-administrator-guide/03-operations/02-upgrade-and-downgrade.md
@@ -1,4 +1,3 @@
# Upgrade and Downgrade
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/03-operations/03-node-decommissioning-and-maintenance/02-storage-container-manager.md
b/docs/05-administrator-guide/03-operations/03-node-decommissioning-and-maintenance/02-storage-container-manager.md
index eb46c35b..01b07478 100644
---
a/docs/05-administrator-guide/03-operations/03-node-decommissioning-and-maintenance/02-storage-container-manager.md
+++
b/docs/05-administrator-guide/03-operations/03-node-decommissioning-and-maintenance/02-storage-container-manager.md
@@ -5,4 +5,3 @@ sidebar_label: Storage Container Manager
# Decommissioning a Storage Container Manager
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/03-operations/03-node-decommissioning-and-maintenance/03-datanodes.md
b/docs/05-administrator-guide/03-operations/03-node-decommissioning-and-maintenance/03-datanodes.md
index cadfe000..52976809 100644
---
a/docs/05-administrator-guide/03-operations/03-node-decommissioning-and-maintenance/03-datanodes.md
+++
b/docs/05-administrator-guide/03-operations/03-node-decommissioning-and-maintenance/03-datanodes.md
@@ -9,5 +9,3 @@ sidebar_label: Datanodes
## Decommissioning
## Maintenance
-
-
diff --git
a/docs/05-administrator-guide/03-operations/04-disk-replacement/02-storage-container-manager.md
b/docs/05-administrator-guide/03-operations/04-disk-replacement/02-storage-container-manager.md
index 3063ce2e..263182e5 100644
---
a/docs/05-administrator-guide/03-operations/04-disk-replacement/02-storage-container-manager.md
+++
b/docs/05-administrator-guide/03-operations/04-disk-replacement/02-storage-container-manager.md
@@ -5,4 +5,3 @@ sidebar_label: Storage Container Manager
# Replacing Storage Container Manager Disks
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/03-operations/04-disk-replacement/03-datanodes.md
b/docs/05-administrator-guide/03-operations/04-disk-replacement/03-datanodes.md
index 8906dcfe..2712745d 100644
---
a/docs/05-administrator-guide/03-operations/04-disk-replacement/03-datanodes.md
+++
b/docs/05-administrator-guide/03-operations/04-disk-replacement/03-datanodes.md
@@ -5,4 +5,3 @@ sidebar_label: Datanodes
# Replacing Datanode Disks
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/03-operations/04-disk-replacement/04-recon.md
b/docs/05-administrator-guide/03-operations/04-disk-replacement/04-recon.md
index e0b915a0..9597162c 100644
--- a/docs/05-administrator-guide/03-operations/04-disk-replacement/04-recon.md
+++ b/docs/05-administrator-guide/03-operations/04-disk-replacement/04-recon.md
@@ -5,4 +5,3 @@ sidebar_label: Recon
# Replacing Recon Disks
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/03-operations/05-balancing-datanodes.md
b/docs/05-administrator-guide/03-operations/05-balancing-datanodes.md
index 1066bcb7..d4b98e02 100644
--- a/docs/05-administrator-guide/03-operations/05-balancing-datanodes.md
+++ b/docs/05-administrator-guide/03-operations/05-balancing-datanodes.md
@@ -1,4 +1,3 @@
# Balancing Datanodes
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/03-operations/09-observability/01-cli.md
b/docs/05-administrator-guide/03-operations/09-observability/01-cli.md
index 1aca902e..682253ee 100644
--- a/docs/05-administrator-guide/03-operations/09-observability/01-cli.md
+++ b/docs/05-administrator-guide/03-operations/09-observability/01-cli.md
@@ -5,4 +5,3 @@ sidebar_label: CLI
# Admin CLI
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
diff --git
a/docs/05-administrator-guide/03-operations/09-observability/03-web-uis.md
b/docs/05-administrator-guide/03-operations/09-observability/03-web-uis.md
index 29372cdf..f0e7974f 100644
--- a/docs/05-administrator-guide/03-operations/09-observability/03-web-uis.md
+++ b/docs/05-administrator-guide/03-operations/09-observability/03-web-uis.md
@@ -1,5 +1,3 @@
# Web UIs
**TODO:** File a subtask under
[HDDS-9859](https://issues.apache.org/jira/browse/HDDS-9859) and complete this
page or section.
-
-
diff --git a/docs/06-troubleshooting/01-startup.md
b/docs/06-troubleshooting/01-startup.md
index 6d9ff481..9200030b 100644
--- a/docs/06-troubleshooting/01-startup.md
+++ b/docs/06-troubleshooting/01-startup.md
@@ -7,4 +7,3 @@ sidebar_label: Startup
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
If issues that show up here are caused by other problems (like certificates),
this page should link to the troubleshooting pages for those aspects.
-
diff --git a/docs/06-troubleshooting/02-safemode.md
b/docs/06-troubleshooting/02-safemode.md
index fd4a7391..95b070fd 100644
--- a/docs/06-troubleshooting/02-safemode.md
+++ b/docs/06-troubleshooting/02-safemode.md
@@ -7,4 +7,3 @@ sidebar_label: Safemode
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
If issues that show up here are caused by other problems (like write
pipelines), this page should link to the troubleshooting pages for those
aspects.
-
diff --git a/docs/06-troubleshooting/03-read-write.md
b/docs/06-troubleshooting/03-read-write.md
index 0bfb3e6f..af8effd4 100644
--- a/docs/06-troubleshooting/03-read-write.md
+++ b/docs/06-troubleshooting/03-read-write.md
@@ -7,4 +7,3 @@ sidebar_label: Read and Write
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
If issues that show up here are caused by other problems (like write
pipelines), this page should link to the troubleshooting pages for those
aspects.
-
diff --git a/docs/06-troubleshooting/04-delete.md
b/docs/06-troubleshooting/04-delete.md
index 3ffb6ce6..10b5fb6e 100644
--- a/docs/06-troubleshooting/04-delete.md
+++ b/docs/06-troubleshooting/04-delete.md
@@ -7,4 +7,3 @@ sidebar_label: Delete
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
This page may need to reference the System Internals page for data deletion.
-
diff --git a/docs/06-troubleshooting/05-recon.md
b/docs/06-troubleshooting/05-recon.md
index 7071f4d5..1f1af628 100644
--- a/docs/06-troubleshooting/05-recon.md
+++ b/docs/06-troubleshooting/05-recon.md
@@ -5,4 +5,3 @@ sidebar_label: Recon
# Troubleshooting Recon
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
-
diff --git a/docs/06-troubleshooting/06-performance.md
b/docs/06-troubleshooting/06-performance.md
index 9e255d78..73bf95e5 100644
--- a/docs/06-troubleshooting/06-performance.md
+++ b/docs/06-troubleshooting/06-performance.md
@@ -7,4 +7,3 @@ sidebar_label: Performance
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
This may need to be converted into a subsection with multiple pages under it.
-
diff --git a/docs/06-troubleshooting/07-integrations/01-placeholder.md
b/docs/06-troubleshooting/07-integrations/01-placeholder.md
index a4e56f3f..11d16344 100644
--- a/docs/06-troubleshooting/07-integrations/01-placeholder.md
+++ b/docs/06-troubleshooting/07-integrations/01-placeholder.md
@@ -3,4 +3,3 @@
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
Add pages under this section for troubleshooting Ozone integration with
various components like Spark.
-
diff --git a/docs/06-troubleshooting/08-security/01-certificates.md
b/docs/06-troubleshooting/08-security/01-certificates.md
index fda29e56..633ec9e4 100644
--- a/docs/06-troubleshooting/08-security/01-certificates.md
+++ b/docs/06-troubleshooting/08-security/01-certificates.md
@@ -5,4 +5,3 @@ sidebar_label: Certificates
# Troubleshooting Certificates
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
-
diff --git a/docs/06-troubleshooting/08-security/02-authentication.md
b/docs/06-troubleshooting/08-security/02-authentication.md
index 94f596bf..c1672325 100644
--- a/docs/06-troubleshooting/08-security/02-authentication.md
+++ b/docs/06-troubleshooting/08-security/02-authentication.md
@@ -11,4 +11,3 @@ sidebar_label: Authentication
## SPNEGO
## S3 Credentials
-
diff --git a/docs/06-troubleshooting/09-upgrade-downgrade.md
b/docs/06-troubleshooting/09-upgrade-downgrade.md
index 48ef383d..460e211e 100644
--- a/docs/06-troubleshooting/09-upgrade-downgrade.md
+++ b/docs/06-troubleshooting/09-upgrade-downgrade.md
@@ -5,4 +5,3 @@ sidebar_label: Upgrades and Downgrades
# Troubleshooting Upgrades and Downgrades
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
-
diff --git a/docs/06-troubleshooting/10-decommission-maintenance.md
b/docs/06-troubleshooting/10-decommission-maintenance.md
index 187c8b84..8a62343e 100644
--- a/docs/06-troubleshooting/10-decommission-maintenance.md
+++ b/docs/06-troubleshooting/10-decommission-maintenance.md
@@ -5,4 +5,3 @@ sidebar_label: Decommissioning and Maintenance
# Troubleshooting Decommissioning and Maintenance
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
-
diff --git a/docs/06-troubleshooting/11-write-pipelines.md
b/docs/06-troubleshooting/11-write-pipelines.md
index 6ea43bbb..ec6bd99b 100644
--- a/docs/06-troubleshooting/11-write-pipelines.md
+++ b/docs/06-troubleshooting/11-write-pipelines.md
@@ -5,4 +5,3 @@ sidebar_label: Write Pipelines
# Troubleshooting Write Pipelines
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
-
diff --git a/docs/06-troubleshooting/12-storage-containers.md
b/docs/06-troubleshooting/12-storage-containers.md
index cf283ab0..83b230f5 100644
--- a/docs/06-troubleshooting/12-storage-containers.md
+++ b/docs/06-troubleshooting/12-storage-containers.md
@@ -5,4 +5,3 @@ sidebar_label: Storage Containers
# Troubleshooting Storage Containers
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
-
diff --git a/docs/06-troubleshooting/13-ratis.md
b/docs/06-troubleshooting/13-ratis.md
index 0671a516..29a41171 100644
--- a/docs/06-troubleshooting/13-ratis.md
+++ b/docs/06-troubleshooting/13-ratis.md
@@ -5,4 +5,3 @@ sidebar_label: Ratis
# Troubleshooting Ratis
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
-
diff --git a/docs/06-troubleshooting/14-rocksdb.md
b/docs/06-troubleshooting/14-rocksdb.md
index 832bc880..f1dbff74 100644
--- a/docs/06-troubleshooting/14-rocksdb.md
+++ b/docs/06-troubleshooting/14-rocksdb.md
@@ -5,4 +5,3 @@ sidebar_label: RocksDB
# Troubleshooting RocksDB
**TODO:** File a subtask under
[HDDS-9860](https://issues.apache.org/jira/browse/HDDS-9860) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/01-ozone-manager/02-rocksdb-schema.md
b/docs/07-system-internals/01-components/01-ozone-manager/02-rocksdb-schema.md
index bd794e5b..b13ce957 100644
---
a/docs/07-system-internals/01-components/01-ozone-manager/02-rocksdb-schema.md
+++
b/docs/07-system-internals/01-components/01-ozone-manager/02-rocksdb-schema.md
@@ -5,4 +5,3 @@ sidebar_label: RocksDB Schema
# Ozone Manager RocksDB Schema
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/01-ozone-manager/03-in-memory-storage.md
b/docs/07-system-internals/01-components/01-ozone-manager/03-in-memory-storage.md
index 6ce55afb..58d6e0d4 100644
---
a/docs/07-system-internals/01-components/01-ozone-manager/03-in-memory-storage.md
+++
b/docs/07-system-internals/01-components/01-ozone-manager/03-in-memory-storage.md
@@ -9,4 +9,3 @@ sidebar_label: In-Memory Storage
- Volume and bucket tables
- RocksDB block cache
- Container cache
-
diff --git
a/docs/07-system-internals/01-components/01-ozone-manager/04-startup-sequence.md
b/docs/07-system-internals/01-components/01-ozone-manager/04-startup-sequence.md
index f66f8add..dc84e1c3 100644
---
a/docs/07-system-internals/01-components/01-ozone-manager/04-startup-sequence.md
+++
b/docs/07-system-internals/01-components/01-ozone-manager/04-startup-sequence.md
@@ -5,5 +5,3 @@ sidebar_label: Startup Sequence
# Ozone Manager Startup Sequence
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
-
diff --git
a/docs/07-system-internals/01-components/01-ozone-manager/05-roles.md
b/docs/07-system-internals/01-components/01-ozone-manager/05-roles.md
index 5f9c85e6..d66b7d72 100644
--- a/docs/07-system-internals/01-components/01-ozone-manager/05-roles.md
+++ b/docs/07-system-internals/01-components/01-ozone-manager/05-roles.md
@@ -5,4 +5,3 @@ sidebar_label: Roles
# Ozone Manager Roles
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/01-ozone-manager/06-write-request-flow.md
b/docs/07-system-internals/01-components/01-ozone-manager/06-write-request-flow.md
index 08e2c2cd..9bd328fc 100644
---
a/docs/07-system-internals/01-components/01-ozone-manager/06-write-request-flow.md
+++
b/docs/07-system-internals/01-components/01-ozone-manager/06-write-request-flow.md
@@ -5,4 +5,3 @@ sidebar_label: Write Request Flow
# Ozone Manager Write Request Flow
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/01-ozone-manager/07-read-request-flow.md
b/docs/07-system-internals/01-components/01-ozone-manager/07-read-request-flow.md
index b6d86a4e..9a7c8f91 100644
---
a/docs/07-system-internals/01-components/01-ozone-manager/07-read-request-flow.md
+++
b/docs/07-system-internals/01-components/01-ozone-manager/07-read-request-flow.md
@@ -5,4 +5,3 @@ sidebar_label: Read Request Flow
# Ozone Manager Read Request Flow
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/02-storage-container-manager/01-disk-layout.md
b/docs/07-system-internals/01-components/02-storage-container-manager/01-disk-layout.md
index 7b7c655f..944ef784 100644
---
a/docs/07-system-internals/01-components/02-storage-container-manager/01-disk-layout.md
+++
b/docs/07-system-internals/01-components/02-storage-container-manager/01-disk-layout.md
@@ -5,4 +5,3 @@ sidebar_label: Disk Layout
# Storage Container Manager Disk Layout
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/02-storage-container-manager/02-rocksdb-schema.md
b/docs/07-system-internals/01-components/02-storage-container-manager/02-rocksdb-schema.md
index ec1a522b..b52f6a58 100644
---
a/docs/07-system-internals/01-components/02-storage-container-manager/02-rocksdb-schema.md
+++
b/docs/07-system-internals/01-components/02-storage-container-manager/02-rocksdb-schema.md
@@ -5,4 +5,3 @@ sidebar_label: RocksDB Schema
# Storage Container Manager RocksDB Schema
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/02-storage-container-manager/03-in-memory-storage.md
b/docs/07-system-internals/01-components/02-storage-container-manager/03-in-memory-storage.md
index 4867f4ed..23870c7e 100644
---
a/docs/07-system-internals/01-components/02-storage-container-manager/03-in-memory-storage.md
+++
b/docs/07-system-internals/01-components/02-storage-container-manager/03-in-memory-storage.md
@@ -5,4 +5,3 @@ sidebar_label: In-Memory Storage
# Storage Container Manager In-Memory Storage
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/02-storage-container-manager/04-startup-sequence.md
b/docs/07-system-internals/01-components/02-storage-container-manager/04-startup-sequence.md
index 14880e06..9826fd68 100644
---
a/docs/07-system-internals/01-components/02-storage-container-manager/04-startup-sequence.md
+++
b/docs/07-system-internals/01-components/02-storage-container-manager/04-startup-sequence.md
@@ -5,4 +5,3 @@ sidebar_label: Startup Sequence
# Storage Container Manager Startup Sequence
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/02-storage-container-manager/05-roles.md
b/docs/07-system-internals/01-components/02-storage-container-manager/05-roles.md
index 3f96aaff..09bfb45e 100644
---
a/docs/07-system-internals/01-components/02-storage-container-manager/05-roles.md
+++
b/docs/07-system-internals/01-components/02-storage-container-manager/05-roles.md
@@ -6,4 +6,4 @@ sidebar_label: Roles
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-- Leader makes writes to state and updates followers based on datanode reports.
+- Leader makes writes to state and updates followers based on Datanode reports.
diff --git
a/docs/07-system-internals/01-components/02-storage-container-manager/06-admin-write-request-flow.md
b/docs/07-system-internals/01-components/02-storage-container-manager/06-admin-write-request-flow.md
index cc48d348..e59b4508 100644
---
a/docs/07-system-internals/01-components/02-storage-container-manager/06-admin-write-request-flow.md
+++
b/docs/07-system-internals/01-components/02-storage-container-manager/06-admin-write-request-flow.md
@@ -5,4 +5,3 @@ sidebar_label: Admin Write Request Flow
# Storage Container Manager Admin Write Request flow
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/02-storage-container-manager/07-admin-read-request-flow.md
b/docs/07-system-internals/01-components/02-storage-container-manager/07-admin-read-request-flow.md
index 8e16fcb5..8b14ca93 100644
---
a/docs/07-system-internals/01-components/02-storage-container-manager/07-admin-read-request-flow.md
+++
b/docs/07-system-internals/01-components/02-storage-container-manager/07-admin-read-request-flow.md
@@ -5,4 +5,3 @@ sidebar_label: Admin Read Request Flow
# Storage Container Manager Admin Read Request Flow
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/03-datanode/01-disk-layout.md
b/docs/07-system-internals/01-components/03-datanode/01-disk-layout.md
index 42079ae4..e12bf7b2 100644
--- a/docs/07-system-internals/01-components/03-datanode/01-disk-layout.md
+++ b/docs/07-system-internals/01-components/03-datanode/01-disk-layout.md
@@ -5,4 +5,3 @@ sidebar_label: Disk Layout
# Datanode Disk Layout
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/03-datanode/02-rocksdb-schema.md
b/docs/07-system-internals/01-components/03-datanode/02-rocksdb-schema.md
index 0f95d3dc..a2181253 100644
--- a/docs/07-system-internals/01-components/03-datanode/02-rocksdb-schema.md
+++ b/docs/07-system-internals/01-components/03-datanode/02-rocksdb-schema.md
@@ -5,4 +5,3 @@ sidebar_label: RocksDB Layout
# Datanode RocksDB Schema
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/03-datanode/03-in-memory-storage.md
b/docs/07-system-internals/01-components/03-datanode/03-in-memory-storage.md
index 95a53a68..abc98834 100644
--- a/docs/07-system-internals/01-components/03-datanode/03-in-memory-storage.md
+++ b/docs/07-system-internals/01-components/03-datanode/03-in-memory-storage.md
@@ -5,4 +5,3 @@ sidebar_label: In-Memory Storage
# Datanode In-Memory Storage
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/03-datanode/04-startup-sequence.md
b/docs/07-system-internals/01-components/03-datanode/04-startup-sequence.md
index 502ac1dd..efe5254a 100644
--- a/docs/07-system-internals/01-components/03-datanode/04-startup-sequence.md
+++ b/docs/07-system-internals/01-components/03-datanode/04-startup-sequence.md
@@ -5,4 +5,3 @@ sidebar_label: Startup Sequence
# Datanode Startup Sequence
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/03-datanode/06-write-request-flow.md
b/docs/07-system-internals/01-components/03-datanode/06-write-request-flow.md
index 8dd02ff2..cd2d7bd9 100644
---
a/docs/07-system-internals/01-components/03-datanode/06-write-request-flow.md
+++
b/docs/07-system-internals/01-components/03-datanode/06-write-request-flow.md
@@ -5,4 +5,3 @@ sidebar_label: Write Request Flow
# Datanode Write Request Flow
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/03-datanode/07-read-request-flow.md
b/docs/07-system-internals/01-components/03-datanode/07-read-request-flow.md
index b4250fa9..264f0555 100644
--- a/docs/07-system-internals/01-components/03-datanode/07-read-request-flow.md
+++ b/docs/07-system-internals/01-components/03-datanode/07-read-request-flow.md
@@ -5,4 +5,3 @@ sidebar_label: Read Request Flow
# Datanode Read Request Flow
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git a/docs/07-system-internals/01-components/04-recon/01-disk-layout.md
b/docs/07-system-internals/01-components/04-recon/01-disk-layout.md
index fd8186a6..5e3207a9 100644
--- a/docs/07-system-internals/01-components/04-recon/01-disk-layout.md
+++ b/docs/07-system-internals/01-components/04-recon/01-disk-layout.md
@@ -5,4 +5,3 @@ sidebar_label: Disk Layout
# Recon Disk Layout
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/04-recon/02-rocksdb-schema.md
b/docs/07-system-internals/01-components/04-recon/02-rocksdb-schema.md
index 6088728b..94829836 100644
--- a/docs/07-system-internals/01-components/04-recon/02-rocksdb-schema.md
+++ b/docs/07-system-internals/01-components/04-recon/02-rocksdb-schema.md
@@ -5,4 +5,3 @@ sidebar_label: RocksDB Layout
# RocksDB Layout
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git a/docs/07-system-internals/01-components/04-recon/03-sql-schema.md
b/docs/07-system-internals/01-components/04-recon/03-sql-schema.md
index 92634d5b..6f41d706 100644
--- a/docs/07-system-internals/01-components/04-recon/03-sql-schema.md
+++ b/docs/07-system-internals/01-components/04-recon/03-sql-schema.md
@@ -5,4 +5,3 @@ sidebar_label: SQL Schema
# SQL Schema
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/04-recon/04-in-memory-storage.md
b/docs/07-system-internals/01-components/04-recon/04-in-memory-storage.md
index 3372ba4d..ab80849b 100644
--- a/docs/07-system-internals/01-components/04-recon/04-in-memory-storage.md
+++ b/docs/07-system-internals/01-components/04-recon/04-in-memory-storage.md
@@ -5,4 +5,3 @@ sidebar_label: In-Memory Storage
# Recon In-Memory Storage
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/04-recon/05-startup-sequence.md
b/docs/07-system-internals/01-components/04-recon/05-startup-sequence.md
index 1397ee9a..10daa7a8 100644
--- a/docs/07-system-internals/01-components/04-recon/05-startup-sequence.md
+++ b/docs/07-system-internals/01-components/04-recon/05-startup-sequence.md
@@ -5,4 +5,3 @@ sidebar_label: Startup Sequence
# Recon Startup Sequence
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/04-recon/06-syncing-data-from-om.md
b/docs/07-system-internals/01-components/04-recon/06-syncing-data-from-om.md
index 7fd9c991..65b75e18 100644
--- a/docs/07-system-internals/01-components/04-recon/06-syncing-data-from-om.md
+++ b/docs/07-system-internals/01-components/04-recon/06-syncing-data-from-om.md
@@ -5,4 +5,3 @@ sidebar_label: Syncing Data From Ozone Manager
# How Recon Syncs Data From Ozone Manager
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/04-recon/07-syncing-data-from-scm.md
b/docs/07-system-internals/01-components/04-recon/07-syncing-data-from-scm.md
index eac7c7ee..63be6b80 100644
---
a/docs/07-system-internals/01-components/04-recon/07-syncing-data-from-scm.md
+++
b/docs/07-system-internals/01-components/04-recon/07-syncing-data-from-scm.md
@@ -5,4 +5,3 @@ sidebar_label: Syncing Data From Storage Container Manager
# How Recon Syncs Data From Storage Container Manager
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/04-recon/08-syncing-data-from-datanodes.md
b/docs/07-system-internals/01-components/04-recon/08-syncing-data-from-datanodes.md
index 5059994a..d9e2d856 100644
---
a/docs/07-system-internals/01-components/04-recon/08-syncing-data-from-datanodes.md
+++
b/docs/07-system-internals/01-components/04-recon/08-syncing-data-from-datanodes.md
@@ -5,4 +5,3 @@ sidebar_label: Syncing Data From Datanodes
# How Recon Syncs Data From Datanodes
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/05-s3-gateway/01-overview.md
b/docs/07-system-internals/01-components/05-s3-gateway/01-overview.md
index caf4dd4c..5c9c5bcf 100644
--- a/docs/07-system-internals/01-components/05-s3-gateway/01-overview.md
+++ b/docs/07-system-internals/01-components/05-s3-gateway/01-overview.md
@@ -11,4 +11,3 @@ sidebar_label: Overview
- No startup steps
- No disk state
- Persistent client connections
-
diff --git
a/docs/07-system-internals/01-components/05-s3-gateway/02-request-flow.md
b/docs/07-system-internals/01-components/05-s3-gateway/02-request-flow.md
index 01d0abc4..f9ff5f4e 100644
--- a/docs/07-system-internals/01-components/05-s3-gateway/02-request-flow.md
+++ b/docs/07-system-internals/01-components/05-s3-gateway/02-request-flow.md
@@ -5,4 +5,3 @@ sidebar_label: Request Flow
# S3 Gateway Request flow
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/01-components/06-client/01-startup-sequence.md
b/docs/07-system-internals/01-components/06-client/01-startup-sequence.md
index e62b63ab..b9662720 100644
--- a/docs/07-system-internals/01-components/06-client/01-startup-sequence.md
+++ b/docs/07-system-internals/01-components/06-client/01-startup-sequence.md
@@ -8,4 +8,3 @@ sidebar_label: Startup Sequence
- Ozone shell script invokes the correct jar.
- Client makes `getServiceInfo` call to Ozone Manager.
-
diff --git
a/docs/07-system-internals/01-components/06-client/02-in-memory-storage.md
b/docs/07-system-internals/01-components/06-client/02-in-memory-storage.md
index 492f671c..a41b821b 100644
--- a/docs/07-system-internals/01-components/06-client/02-in-memory-storage.md
+++ b/docs/07-system-internals/01-components/06-client/02-in-memory-storage.md
@@ -8,4 +8,3 @@ sidebar_label: In-Memory Storage
- Info the client saves after the get service info call.
- Ratis client cache, current OM leader.
-
diff --git a/docs/07-system-internals/02-data-operations/01-write.md
b/docs/07-system-internals/02-data-operations/01-write.md
index 2190f766..361f890c 100644
--- a/docs/07-system-internals/02-data-operations/01-write.md
+++ b/docs/07-system-internals/02-data-operations/01-write.md
@@ -11,26 +11,26 @@ sidebar_label: Write
## Writing Data
Trace every part of a write request from beginning to end. This includes:
+
- Client getting encryption keys
- Client calling OM to create key
- OM validating client's Kerberos principal
- OM checking permissions (Ranger or Native ACLs)
- OM allocating blocks from SCM
- OM creating open key
- - Mention open key cleanup service, and that if key is not committed
within a given time it will be picked up for [deletion](./delete#deleting-data)
+ - Mention open key cleanup service, and that if key is not committed within
a given time it will be picked up for [deletion](./delete#deleting-data)
- OM generating block tokens from the shared secret previously retrieved from
SCM
- OM returning container, blocks, pipeline, block tokens
-- Client sending checksums and datanodes validating
-- Client sending block tokens and datanode validating based on the shared
secret from SCM
-- Client sending write chunk and put block requests to the datanodes
- - For Ratis:
- - Include topology choices of which datanodes to use
- - Include failover handling
- - For [EC](../features/erasure-coding) and [Ratis
Streaming](../features/ratis-streaming), link to their feature pages.
+- Client sending checksums and Datanodes validating
+- Client sending block tokens and Datanode validating based on the shared
secret from SCM
+- Client sending write chunk and put block requests to the Datanodes
+ - For Ratis:
+ - Include topology choices of which Datanodes to use
+ - Include failover handling
+ - For [EC](../features/erasure-coding) and Ratis Streaming, link to their
feature pages.
- Client allocating more blocks if needed
- Client committing to OM
- OM checking the current namespace
- - Bucket must still exist
- - Existing key will be overwritten
+ - Bucket must still exist
+ - Existing key will be overwritten
- OM committing the data and returning to the client
-
diff --git a/docs/07-system-internals/02-data-operations/02-read.md
b/docs/07-system-internals/02-data-operations/02-read.md
index 0fe6483e..c1670390 100644
--- a/docs/07-system-internals/02-data-operations/02-read.md
+++ b/docs/07-system-internals/02-data-operations/02-read.md
@@ -11,6 +11,7 @@ sidebar_label: Read
## Reading Data
Trace every part of a read request from beginning to end. This includes:
+
- Client getting encryption keys
- Client calling OM to create key
- OM validating client's Kerberos principal
@@ -18,11 +19,10 @@ Trace every part of a read request from beginning to end.
This includes:
- OM generating block tokens from the shared secret previously retrieved from
SCM
- OM getting block locations from SCM or from its cache.
- OM returning container, blocks, pipeline, block tokens
-- Client sending block tokens and datanode validating based on the shared
secret from SCM
-- Client sending read chunk requests to datanode to fetch the data.
- - For replication:
- - Include topology choices of which datanodes to use
- - Include failover handling
- - For EC, link to the [EC feature page](../features/erasure-coding).
+- Client sending block tokens and Datanode validating based on the shared
secret from SCM
+- Client sending read chunk requests to Datanode to fetch the data.
+ - For replication:
+ - Include topology choices of which Datanodes to use
+ - Include failover handling
+ - For EC, link to the [EC feature page](../features/erasure-coding).
- Client validating checksums
-
diff --git a/docs/07-system-internals/02-data-operations/03-delete.md
b/docs/07-system-internals/02-data-operations/03-delete.md
index 2cf16403..83283940 100644
--- a/docs/07-system-internals/02-data-operations/03-delete.md
+++ b/docs/07-system-internals/02-data-operations/03-delete.md
@@ -11,6 +11,7 @@ sidebar_label: Delete
## Deleting Data
Trace every part of a delete request from beginning to end. This includes:
+
- Client getting encryption keys
- Client calling OM to delete the key
- OM validating client's Kerberos principal
@@ -18,8 +19,7 @@ Trace every part of a delete request from beginning to end.
This includes:
- OM marking the key for deletion and removing it from the namespace.
- OM acking to the client
- OM sending blocks to delete to SCM
-- SCM sending blocks to delete to the datanode
+- SCM sending blocks to delete to the Datanode
- Datanode removes data
Note that delete works the same regardless of replication type. Also document
timing of background services and their batch size to estimate the rate of
deletion.
-
diff --git a/docs/07-system-internals/02-data-operations/04-hsync.md
b/docs/07-system-internals/02-data-operations/04-hsync.md
index 4c1b5f40..0321e317 100644
--- a/docs/07-system-internals/02-data-operations/04-hsync.md
+++ b/docs/07-system-internals/02-data-operations/04-hsync.md
@@ -11,4 +11,3 @@ sidebar_label: HFlush and HSync
## HFlush
## HSync
-
diff --git a/docs/07-system-internals/03-data-integrity/01-checksums.md
b/docs/07-system-internals/03-data-integrity/01-checksums.md
index 261734b7..8af8528d 100644
--- a/docs/07-system-internals/03-data-integrity/01-checksums.md
+++ b/docs/07-system-internals/03-data-integrity/01-checksums.md
@@ -7,4 +7,3 @@ sidebar_label: Checksums
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document the internal implementations of read and write checksums for chunks
and stripes.
-
diff --git a/docs/07-system-internals/03-data-integrity/02-container-scanner.md
b/docs/07-system-internals/03-data-integrity/02-container-scanner.md
index 5cca2a7a..67d43975 100644
--- a/docs/07-system-internals/03-data-integrity/02-container-scanner.md
+++ b/docs/07-system-internals/03-data-integrity/02-container-scanner.md
@@ -1,4 +1,3 @@
# Datanode Container Scanner
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git a/docs/07-system-internals/03-data-integrity/03-volume-scanner.md
b/docs/07-system-internals/03-data-integrity/03-volume-scanner.md
index 91a945ce..b05c3557 100644
--- a/docs/07-system-internals/03-data-integrity/03-volume-scanner.md
+++ b/docs/07-system-internals/03-data-integrity/03-volume-scanner.md
@@ -1,4 +1,3 @@
# Datanode Volume Scanner
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/01-overview.md
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/01-overview.md
index fb9f780b..98b295c4 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/01-overview.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/01-overview.md
@@ -5,4 +5,3 @@ sidebar_label: Overview
# Write Pipeline Overview
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/02-types.md
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/02-types.md
index 2ba7c96c..2a936382 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/02-types.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/02-types.md
@@ -7,4 +7,3 @@ sidebar_label: Types
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document differences in Ratis, EC, and Standalone write pipelines.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/03-states.md
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/03-states.md
index 8f316319..c11c9559 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/03-states.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/03-states.md
@@ -5,4 +5,3 @@ sidebar_label: States
# Write Pipeline States
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/04-reports.md
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/04-reports.md
index 4c1bd119..22cbbac0 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/04-reports.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/04-reports.md
@@ -5,4 +5,3 @@ sidebar_label: Reports
# Write Pipeline Reports
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/05-creation.md
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/05-creation.md
index e2e60df0..69e41bfb 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/05-creation.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/05-creation.md
@@ -5,4 +5,3 @@ sidebar_label: Creation
# Write Pipeline Creation
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/06-persistence.md
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/06-persistence.md
index 308f17cf..3f13b01e 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/06-persistence.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/06-persistence.md
@@ -7,4 +7,3 @@ sidebar_label: Persistence
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document how write pipelines are persisted on SCM and Datanodes and re-used on
restart.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/07-destruction.md
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/07-destruction.md
index a2ce78f6..82c0a0ac 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/07-destruction.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/01-write-pipelines/07-destruction.md
@@ -7,4 +7,3 @@ sidebar_label: Destruction
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document conditions that can cause a write pipeline to be closed, and what
steps are taken when this happens.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/01-overview.md
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/01-overview.md
index 3babdaf9..827cf650 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/01-overview.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/01-overview.md
@@ -5,4 +5,3 @@ sidebar_label: Overview
# Containers Overview
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/02-types.md
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/02-types.md
index 510e5dff..3069b1a1 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/02-types.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/02-types.md
@@ -7,4 +7,3 @@ sidebar_label: Types
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document differences in Ratis, EC (data and parity), and Standalone containers.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/03-states.md
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/03-states.md
index edbfdf3d..1ce2156e 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/03-states.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/03-states.md
@@ -7,4 +7,3 @@ sidebar_label: States
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document container states in SCM and replicas.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/04-reports.md
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/04-reports.md
index 532d6e07..c6514c41 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/04-reports.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/04-reports.md
@@ -5,4 +5,3 @@ sidebar_label: Reports
# Container Reports
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/05-creation.md
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/05-creation.md
index 2d43153a..99d0b844 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/05-creation.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/05-creation.md
@@ -5,4 +5,3 @@ sidebar_label: Creation
# Container Creation
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/06-persistence.md
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/06-persistence.md
index f56a02a1..729e3e5b 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/06-persistence.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/06-persistence.md
@@ -7,4 +7,3 @@ sidebar_label: Persistence
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document how write containers are persisted on SCM and Datanodes and re-used
on restart.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/07-destruction.md
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/07-destruction.md
index 56f4203e..5189a3ad 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/07-destruction.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/07-destruction.md
@@ -5,4 +5,3 @@ sidebar_label: Deletion
# Container Deletion
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/08-replication.md
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/08-replication.md
index 17a83d40..8e4e3ddf 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/08-replication.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/08-replication.md
@@ -6,4 +6,4 @@ sidebar_label: Replication
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-Document replication process among datanodes. Advantages of push replication
and cases where an EC container can be replicated, like decommissioning.
+Document replication process among Datanodes. Advantages of push replication
and cases where an EC container can be replicated, like decommissioning.
diff --git
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/09-offline-reconstruction.md
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/09-offline-reconstruction.md
index 2fea3bc9..a4c375b6 100644
---
a/docs/07-system-internals/04-replication/02-data-replication/02-containers/09-offline-reconstruction.md
+++
b/docs/07-system-internals/04-replication/02-data-replication/02-containers/09-offline-reconstruction.md
@@ -7,4 +7,3 @@ sidebar_label: Reconstruction
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document EC offline reconstruction process.
-
diff --git a/docs/07-system-internals/05-security/01-kerberos.md
b/docs/07-system-internals/05-security/01-kerberos.md
index 8885c782..cd84e4f0 100644
--- a/docs/07-system-internals/05-security/01-kerberos.md
+++ b/docs/07-system-internals/05-security/01-kerberos.md
@@ -7,4 +7,3 @@ sidebar_label: Kerberos
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document which Ozone components use Kerberos, what calls they make, and why.
-
diff --git a/docs/07-system-internals/05-security/02-symmetric-encryption.md
b/docs/07-system-internals/05-security/02-symmetric-encryption.md
index c5b45d84..846c8772 100644
--- a/docs/07-system-internals/05-security/02-symmetric-encryption.md
+++ b/docs/07-system-internals/05-security/02-symmetric-encryption.md
@@ -7,4 +7,3 @@ sidebar_label: Symmetric Encryption
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document Ozone's shared secret model and how it is used within Ozone
components. Also document performance advantages over asymmetric encryption.
-
diff --git a/docs/07-system-internals/05-security/03-tokens.md
b/docs/07-system-internals/05-security/03-tokens.md
index 89164f6d..34490d7b 100644
--- a/docs/07-system-internals/05-security/03-tokens.md
+++ b/docs/07-system-internals/05-security/03-tokens.md
@@ -7,4 +7,3 @@ sidebar_label: Tokens
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document how Ozone generates and uses container and block tokens, and why they
are used.
-
diff --git a/docs/07-system-internals/05-security/04-certificates.md
b/docs/07-system-internals/05-security/04-certificates.md
index 9b59cc5d..b93a8f05 100644
--- a/docs/07-system-internals/05-security/04-certificates.md
+++ b/docs/07-system-internals/05-security/04-certificates.md
@@ -7,4 +7,3 @@ sidebar_label: Certificates
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document how Ozone generates and uses certificates. This includes primordial
SCM and SCMs as root and sub-CAs.
-
diff --git a/docs/07-system-internals/05-security/05-tls.md
b/docs/07-system-internals/05-security/05-tls.md
index 2bcc0934..422d7648 100644
--- a/docs/07-system-internals/05-security/05-tls.md
+++ b/docs/07-system-internals/05-security/05-tls.md
@@ -7,4 +7,3 @@ sidebar_label: TLS
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document how Ozone sets up TLS/mTLS connections between components.
-
diff --git a/docs/07-system-internals/05-security/06-sasl.md
b/docs/07-system-internals/05-security/06-sasl.md
index 9cb3c184..aac388aa 100644
--- a/docs/07-system-internals/05-security/06-sasl.md
+++ b/docs/07-system-internals/05-security/06-sasl.md
@@ -5,4 +5,3 @@ sidebar_label: SASL
# SASL Within Ozone
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git a/docs/07-system-internals/05-security/07-s3-credentials.md
b/docs/07-system-internals/05-security/07-s3-credentials.md
index 4d236e27..d55b0a3b 100644
--- a/docs/07-system-internals/05-security/07-s3-credentials.md
+++ b/docs/07-system-internals/05-security/07-s3-credentials.md
@@ -7,4 +7,3 @@ sidebar_label: S3 Credentials
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
Document how Ozone maps S3 credentials to Kerberos principals for
authentication.
-
diff --git a/docs/07-system-internals/06-network-protocols/01-overview.md
b/docs/07-system-internals/06-network-protocols/01-overview.md
index 440230ec..bfe2c6e0 100644
--- a/docs/07-system-internals/06-network-protocols/01-overview.md
+++ b/docs/07-system-internals/06-network-protocols/01-overview.md
@@ -6,5 +6,4 @@ sidebar_label: Overview
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-Provide a list of the different network protocols used within Ozone (GRPC,
Hadoop RPC, Netty, HTTP) their purpose, and how they are secured (TLS, SASL). A
system diagram with each connection's protocol labelled would be good to have
here too.
-
+Provide a list of the different network protocols used within Ozone (gRPC,
Hadoop RPC, Netty, HTTP) their purpose, and how they are secured (TLS, SASL). A
system diagram with each connection's protocol labelled would be good to have
here too.
diff --git a/docs/07-system-internals/06-network-protocols/02-client.md
b/docs/07-system-internals/06-network-protocols/02-client.md
index ab1cd067..effe0270 100644
--- a/docs/07-system-internals/06-network-protocols/02-client.md
+++ b/docs/07-system-internals/06-network-protocols/02-client.md
@@ -10,15 +10,14 @@ For each section, indicate the network protocol that is
used, why it is used, an
| Client | Server | Protocol | Authentication | Authorization | Encryption |
Notes |
|-|-|-|-|-|-|-|
-S3 Client | S3 Gateway | HTTPS | S3 Secrets | ACLs | TLS | S3 gateway REST API
is compatible with regular S3 HTTP clients.
-HDFS Client | Ozone Manager | Hadoop RPC | Kerberos | ACLs | SASL | HDFS
client uses Ozone client jar internally to communicate with Ozone.
-Ozone Client | Ozone Manager | Hadoop RPC | Kerberos | ACLs | SASL | Hadoop
RPC is used to transfer Kerberos information.
-Ozone Client | Storage Container Manager | | | | | |
-Ozone Client | Datanode | gRPC | | | | |
-Ozone Client | Kerberos KDC | | | | | |
-Ozone Client | Ranger KMS | | | | | |
-REST Client | HttpFS Server | | | | | |
-REST Client | Recon REST API | HTTPS | Kerberos + SPNEGO | [Configured Ozone
Administrators](../../administrator-guide/configuration/security/administrators)
| TLS | |
-Web Browser | Recon UI | HTTPS | Kerberos + SPNEGO/Apache Knox | [Configured
Ozone
Administrators](../../administrator-guide/configuration/security/administrators)
| TLS | |
-Web Browser | Ozone WebUIs | HTTPS | Kerberos + SPNEGO/Apache Knox | | TLS | |
-
+| S3 Client | S3 Gateway | HTTPS | S3 Secrets | ACLs | TLS | S3 Gateway REST
API is compatible with regular S3 HTTP clients. |
+| HDFS Client | Ozone Manager | Hadoop RPC | Kerberos | ACLs | SASL | HDFS
client uses Ozone client jar internally to communicate with Ozone. |
+| Ozone Client | Ozone Manager | Hadoop RPC | Kerberos | ACLs | SASL | Hadoop
RPC is used to transfer Kerberos information. |
+| Ozone Client | Storage Container Manager | | | | | |
+| Ozone Client | Datanode | gRPC | | | | |
+| Ozone Client | Kerberos KDC | | | | | |
+| Ozone Client | Ranger KMS | | | | | |
+| REST Client | HttpFS Server | | | | | |
+| REST Client | Recon REST API | HTTPS | Kerberos + SPNEGO | [Configured Ozone
Administrators](../../administrator-guide/configuration/security/administrators)
| TLS | |
+| Web Browser | Recon UI | HTTPS | Kerberos + SPNEGO/Apache Knox | [Configured
Ozone
Administrators](../../administrator-guide/configuration/security/administrators)
| TLS | |
+| Web Browser | Ozone WebUIs | HTTPS | Kerberos + SPNEGO/Apache Knox | | TLS |
|
diff --git a/docs/07-system-internals/06-network-protocols/03-server.md
b/docs/07-system-internals/06-network-protocols/03-server.md
index b6242045..8035e6cf 100644
--- a/docs/07-system-internals/06-network-protocols/03-server.md
+++ b/docs/07-system-internals/06-network-protocols/03-server.md
@@ -10,14 +10,13 @@ For each section, indicate the network protocol that is
used, why it is used, an
| Client | Server | Protocol | Authentication | Encryption | Notes |
|-|-|-|-|-|-|
-Ozone Manager | Storage Container Manager | gRPC | Certificate | TLS | Used to
allocate blocks, delete blocks, and get block locations.
-Ozone Manager | Ranger | | | |
-Ozone Manager | S3 Secret Store | | | |
-Datanode | Datanode | | | |
-Datanode | Storage Container Manager | | | |
-Datanode | Recon | | | |
-Recon | Ozone Manager | | | |
-Recon | Storage Container Manager | | | |
-All Ozone Components | Kerberos KDC | | | |
-Prometheus | All Ozone Components | | | |
-
+| Ozone Manager | Storage Container Manager | gRPC | Certificate | TLS | Used
to allocate blocks, delete blocks, and get block locations. |
+| Ozone Manager | Ranger | | | | |
+| Ozone Manager | S3 Secret Store | | | | |
+| Datanode | Datanode | | | | |
+| Datanode | Storage Container Manager | | | | |
+| Datanode | Recon | | | | |
+| Recon | Ozone Manager | | | | |
+| Recon | Storage Container Manager | | | | |
+| All Ozone Components | Kerberos KDC | | | | |
+| Prometheus | All Ozone Components | | | | |
diff --git a/docs/07-system-internals/07-features/01-filesystem-optimization.md
b/docs/07-system-internals/07-features/01-filesystem-optimization.md
index a9f666b2..6cc2d1f4 100644
--- a/docs/07-system-internals/07-features/01-filesystem-optimization.md
+++ b/docs/07-system-internals/07-features/01-filesystem-optimization.md
@@ -5,4 +5,3 @@ sidebar_label: Filesystem Optimization (FSO)
# File System Optimization (FSO) System Internals
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git a/docs/07-system-internals/07-features/03-bucket-snapshots.md
b/docs/07-system-internals/07-features/03-bucket-snapshots.md
index d6326fde..40ed8b8d 100644
--- a/docs/07-system-internals/07-features/03-bucket-snapshots.md
+++ b/docs/07-system-internals/07-features/03-bucket-snapshots.md
@@ -5,4 +5,3 @@ sidebar_label: Bucket Snapshot
# Bucket Snapshot System Internals
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git a/docs/07-system-internals/07-features/04-erasure-coding.md
b/docs/07-system-internals/07-features/04-erasure-coding.md
index cf3c54b2..1fb01c8e 100644
--- a/docs/07-system-internals/07-features/04-erasure-coding.md
+++ b/docs/07-system-internals/07-features/04-erasure-coding.md
@@ -5,4 +5,3 @@ sidebar_label: Erasure Coding
# Erasure Coding System Internals
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git a/docs/07-system-internals/07-features/05-ratis-streaming.md
b/docs/07-system-internals/07-features/05-ratis-streaming.md
index 6276509e..d789ec6c 100644
--- a/docs/07-system-internals/07-features/05-ratis-streaming.md
+++ b/docs/07-system-internals/07-features/05-ratis-streaming.md
@@ -7,4 +7,3 @@ sidebar_label: Ratis Streaming
# Ratis Streaming System Internals
**TODO:** File a subtask under
[HDDS-9862](https://issues.apache.org/jira/browse/HDDS-9862) and complete this
page or section.
-
diff --git a/docs/08-developer-guide/01-build/01-prerequisites.md
b/docs/08-developer-guide/01-build/01-prerequisites.md
index e812515c..0e5b0bc0 100644
--- a/docs/08-developer-guide/01-build/01-prerequisites.md
+++ b/docs/08-developer-guide/01-build/01-prerequisites.md
@@ -6,7 +6,7 @@ sidebar_label: Prerequisites
**TODO:** File a subtask under
[HDDS-9861](https://issues.apache.org/jira/browse/HDDS-9861) and complete this
page or section.
-- Minimum maven and java versions required to build Ozone.
+- Minimum Maven and Java versions required to build Ozone.
- Install other necessary libraries like Proto 2.5 or RocksDB if necessary.
- Setup on an aarch64 machine like Apple Silicon.
- Choosing which version to build (master vs. the corresponding tag names for
each release).
diff --git a/docs/08-developer-guide/01-build/02-maven.md
b/docs/08-developer-guide/01-build/02-maven.md
index ebe2f775..11308d07 100644
--- a/docs/08-developer-guide/01-build/02-maven.md
+++ b/docs/08-developer-guide/01-build/02-maven.md
@@ -6,5 +6,5 @@ sidebar_label: Maven
**TODO:** File a subtask under
[HDDS-9861](https://issues.apache.org/jira/browse/HDDS-9861) and complete this
page or section.
-- Cover basic maven commands to build and run tests.
-- Document all the Ozone specific maven flags we use to speed up or skip parts
of the build, and when they are useful.
+- Cover basic Maven commands to build and run tests.
+- Document all the Ozone specific Maven flags we use to speed up or skip parts
of the build, and when they are useful.
diff --git a/docs/08-developer-guide/01-build/04-docker-images.md
b/docs/08-developer-guide/01-build/04-docker-images.md
index efb8fceb..8f49ee45 100644
--- a/docs/08-developer-guide/01-build/04-docker-images.md
+++ b/docs/08-developer-guide/01-build/04-docker-images.md
@@ -6,6 +6,6 @@ sidebar_label: Docker Images
**TODO:** File a subtask under
[HDDS-9861](https://issues.apache.org/jira/browse/HDDS-9861) and complete this
page or section.
-- Point to the ozone-docker repo and define its purpose as a testing/demo
image with Ozone binaries included.
-- Point to the ozone-docker-runner repo and define its purpose as a test image
where Ozone binaries can be mounted.
+- Point to the `ozone-docker` repo and define its purpose as a testing/demo
image with Ozone binaries included.
+- Point to the `ozone-docker-runner` repo and define its purpose as a test
image where Ozone binaries can be mounted.
- Instructions for building the images from source, customizing architecture
(arm).
diff --git a/docs/08-developer-guide/02-run/02-docker-compose.md
b/docs/08-developer-guide/02-run/02-docker-compose.md
index f8cbbbc4..8d756f93 100644
--- a/docs/08-developer-guide/02-run/02-docker-compose.md
+++ b/docs/08-developer-guide/02-run/02-docker-compose.md
@@ -7,6 +7,6 @@ sidebar_label: Docker Compose
**TODO:** File a subtask under
[HDDS-9861](https://issues.apache.org/jira/browse/HDDS-9861) and complete this
page or section.
- Reference common clusters from acceptance tests that can be used.
-- Define the Ozone runner image at ozone-docker-runner and its purpose to wrap
Ozone binaries.
+- Define the Ozone runner image at `ozone-docker-runner` and its purpose to
wrap Ozone binaries.
- How to define which image gets used in the cluster (runner or other
pre-built image).
-- Changing configurations in Docker compose (docker-config file,
transformation.py, etc).
+- Changing configurations in Docker Compose (`docker-config` file,
transformation.py, etc).
diff --git a/docs/08-developer-guide/03-test/02-integration-tests.md
b/docs/08-developer-guide/03-test/02-integration-tests.md
index c9850955..f6a45726 100644
--- a/docs/08-developer-guide/03-test/02-integration-tests.md
+++ b/docs/08-developer-guide/03-test/02-integration-tests.md
@@ -5,4 +5,3 @@
- Scope. When to use integration tests vs unit or acceptance.
- What is MinOzoneCluster?
- Package structure. (integration-test package and dependency reasons for
having its own package)
-
diff --git a/docs/08-developer-guide/03-test/04-continuous-integration.md
b/docs/08-developer-guide/03-test/04-continuous-integration.md
index 2b154c69..91f6df1e 100644
--- a/docs/08-developer-guide/03-test/04-continuous-integration.md
+++ b/docs/08-developer-guide/03-test/04-continuous-integration.md
@@ -7,8 +7,8 @@ sidebar_label: Continuous Integration
**TODO:** File a subtask under
[HDDS-9861](https://issues.apache.org/jira/browse/HDDS-9861) and complete this
page or section.
Aggregate content from our various GitHub actions guides, including
+
- [ci.md](https://github.com/apache/ozone/blob/master/.github/ci.md)
-
[CONTRIBUTING.md](https://github.com/apache/ozone/blob/master/CONTRIBUTING.md#check-your-contribution)
-
https://cwiki.apache.org/confluence/display/OZONE/Ozone+CI+with+Github+Actions
-
https://cwiki.apache.org/confluence/display/OZONE/Github+Actions+tips+and+tricks.
-
diff --git a/docs/08-developer-guide/04-project/01-branches-and-tags.md
b/docs/08-developer-guide/04-project/01-branches-and-tags.md
index 06db9aec..57784fbe 100644
--- a/docs/08-developer-guide/04-project/01-branches-and-tags.md
+++ b/docs/08-developer-guide/04-project/01-branches-and-tags.md
@@ -10,5 +10,4 @@
- When to use feature branches
- Feature branch merge process, including vote and checklist from Confluence.
- - Checklist can be attached to Github PR and mailing list, does not need
to be updated on the website.
-
+ - Checklist can be attached to Github PR and mailing list, does not need to
be updated on the website.
diff --git a/docs/08-developer-guide/04-project/02-release-guide.md
b/docs/08-developer-guide/04-project/02-release-guide.md
index f643dbc8..74dda09f 100644
--- a/docs/08-developer-guide/04-project/02-release-guide.md
+++ b/docs/08-developer-guide/04-project/02-release-guide.md
@@ -4,7 +4,7 @@ sidebar_label: Release Manager Guide
# Custom words specific to this page:
# cSpell:ignore protoroot codesigningkey lockdir pinentry gpgconf
orgapacheozone
-# On this page, don't check spelling of CLI options used with -D or -P.
+# On this page, ignore CLI options used with -D or -P.
# cSpell:ignoreRegExp -(D|P)[a-z\.,]+([\s]|=)
---
@@ -60,7 +60,7 @@ svn cp -m "ozone: adding key of <name> to the KEYS"
https://dist.apache.org/repo
### Create a Parent Jira for the Release
-This provides visibility into the progress of the release for the community.
Tasks mentioned in this guide like cherry-picking fixes on to the release
branch, updating the ozone website, publishing the docker image, etc can be
added as subtasks.
+This provides visibility into the progress of the release for the community.
Tasks mentioned in this guide like cherry-picking fixes on to the release
branch, updating the Ozone website, publishing the Docker image, etc can be
added as subtasks.
### Bulk Comment on Jiras Targeting This Release
@@ -103,6 +103,7 @@ Protolock files are used to check backwards compatibility
of protocol buffers be
```
2. Commit changes to the `proto.lock` files.
+
```bash
git commit -m "Update proto.lock for Ozone $VERSION"
```
@@ -113,7 +114,7 @@ Protolock files are used to check backwards compatibility
of protocol buffers be
:::tip
Ozone currently uses the following protolock files:
- - `hadoop-hdds/interface-client/src/main/resources/proto.lock`: Controls
the protocol for clients communicating with datanodes.
+ - `hadoop-hdds/interface-client/src/main/resources/proto.lock`: Controls
the protocol for clients communicating with Datanodes.
- `hadoop-hdds/interface-admin/src/main/resources/proto.lock`: Controls
the protocol for clients communicating with SCM.
- `hadoop-hdds/interface-server/src/main/resources/proto.lock`: Controls
the protocol for SCMs communicating with each other.
- `hadoop-ozone/interface-client/src/main/resources/proto.lock`: Controls
all protocols involving the Ozone Manager.
@@ -152,6 +153,7 @@ export RC=0 # Set to the number of the current release
candidate, starting at 0.
It is probably best to clone a fresh Ozone repository locally to work on the
release, and leave your existing repository intact for dev tasks you may be
working on simultaneously. After cloning, make sure the git remote for the
[apache/ozone](https://github.com/apache/ozone) upstream repo is named
`origin`. This is required for release build metadata to be correctly populated.
Run the following commands to make sure your repo is clean:
+
```bash
git reset --hard
git clean -dfx
@@ -194,23 +196,32 @@ git tag -s "ozone-$VERSION-RC$RC"
:::tip
If the command fails on MacOS, you may need to do the following additional
steps:
-- Install a program to prompt you for your gpg key passphrase (example using
homebrew):
+- Install a program to prompt you for your GPG key passphrase (example using
homebrew):
+
```bash
brew install pinentry-mac
```
+
- Tell git to use this program for signing:
+
```bash
git config --global gpg.program "$(which gpg)"
```
+
- Tell git which key to sign with:
+
```bash
git config --global user.signingKey <gpg_key_id>
```
-- Tell gpg to use this program to prompt for passphrase:
+
+- Tell GPG to use this program to prompt for passphrase:
+
```bash
echo "pinentry-program $(which pinentry-mac)" > ~/.gnupg/gpg-agent.conf
```
-- Reload gpg-agent:
+
+- Reload `gpg-agent`:
+
```bash
gpgconf --kill gpg-agent
```
@@ -220,19 +231,26 @@ If the command fails on MacOS, you may need to do the
following additional steps
### Create the Release Artifacts
- Run rat check and ensure there are no failures.
+
```bash
./hadoop-ozone/dev-support/checks/rat.sh
```
+
- Clean the Repo of all Rat output
+
```bash
git reset --hard
git clean -dfx
```
+
- Build the Release Tarballs. Make sure you are using GNU-tar instead of
BSD-tar.
+
```bash
mvn clean install -Dmaven.javadoc.skip=true -DskipTests -Psign,dist,src
-Dtar -Dgpg.keyname="$CODESIGNINGKEY"
```
+
- Now that we have built the release artifacts, we will copy them to the
release directory.
+
```bash
cp hadoop-ozone/dist/target/ozone-*.tar.gz "$RELEASE_DIR"/
```
@@ -256,25 +274,31 @@ Now each .tar.gz file should have an associated .mds
file, .asc file, and .sha51
Before uploading the artifacts, run some basic tests on them, similar to what
other devs will run before voting in favor of the release.
-1. Extract the contents of the source tarball and build it with an empty maven
cache by renaming your `~/.m2` directory before doing the build.
+1. Extract the contents of the source tarball and build it with an empty Maven
cache by renaming your `~/.m2` directory before doing the build.
2. Check the size of the output binary tarball for significant size increase
from the last release.
- A significant increase in size could indicate a dependency issue that
needs to be fixed.
- The Apache svn repo has a size limit for release artifacts. If uploading
svn fails because the tarball is too big, we need to contact INFRA to increase
our repo size. [See here for
details.](https://issues.apache.org/jira/browse/INFRA-23892)
3. Verify signatures
- - Download the KEYS file from
[https://dist.apache.org/repos/dist/release/ozone/KEYS](https://dist.apache.org/repos/dist/release/ozone/KEYS)
- - Import its contents (which should include your public gpg key):
+ - Download the KEYS file from
https://dist.apache.org/repos/dist/release/ozone/KEYS
+ - Import its contents (which should include your public GPG key):
+
```bash
gpg --import KEYS
```
+
- Verify each .tar.gz artifact:
+
```bash
gpg --verify <artifact>.tar.gz.asc <artifact>.tar.gz
```
+
4. Verify checksums
- For each artifact, verify that the checksums given by the `shasum`
command match the contents of the .sha512 file and the SHA512 line in its .mds
file.
+
```bash
shasum -a 512 *.tar.gz
```
+
5. Make sure docs are present in the release tarball
- Extract the release and open docs/index.html in your web browser, and
check that the documentation website looks ok.
6. Run `bin/ozone version` from the extracted release tarball. The output of
this command should contain:
@@ -305,7 +329,7 @@ Before uploading the artifacts, run some basic tests on
them, similar to what ot
### Upload the Artifacts to Apache Nexus
-Double check that your apache credentials are added to your local
`~/.m2/settings.xml`.
+Double check that your Apache credentials are added to your local
`~/.m2/settings.xml`.
```xml title="settings.xml"
<settings>
@@ -346,8 +370,8 @@ Send a vote email to the [email protected] mailing
list. Include the followin
- Link to the release candidate tag on Github
- Link to a Jira query showing all resolved issues for this release. Something
like
[this](https://issues.apache.org/jira/issues/?jql=project%20%3D%20HDDS%20AND%20status%20in%20(Resolved%2C%20Closed)%20AND%20fixVersion%20%3D%201.4.0).
- Location of the source and binary tarballs. This link will look something
like https://dist.apache.org/repos/dist/dev/ozone/1.2.0-rc0
-- Location where the maven artifacts are staged. This link will look something
like
[https://repository.apache.org/content/repositories/orgapacheozone-1001/](https://repository.apache.org/content/repositories/orgapacheozone-1001/)
-- Link to the public key used to sign the artifacts. This should always be in
the KEYS file and you can just link to that:
[https://dist.apache.org/repos/dist/dev/ozone/KEYS](https://dist.apache.org/repos/dist/dev/ozone/KEYS)
+- Location where the Maven artifacts are staged. This link will look something
like https://repository.apache.org/content/repositories/orgapacheozone-1001/
+- Link to the public key used to sign the artifacts. This should always be in
the KEYS file and you can just link to that:
https://dist.apache.org/repos/dist/dev/ozone/KEYS
- Fingerprint of the key used to sign the artifacts.
If no issues are found with the artifacts, let the vote run for 7 days. Review
the [ASF wide release voting
policy](https://www.apache.org/legal/release-policy.html#release-approval), and
note the requirements for binding votes which can only come from PMC members.
Sometimes responders will not specify whether their vote is binding. If in
doubt check the [ASF committer
index](https://people.apache.org/committer-index.html). Users whose group
membership includes `ozone-pmc` can cast bindi [...]
@@ -401,7 +425,7 @@ git push origin "ozone-$VERSION"
### Publish a Docker Image for the Release
-The Ozone docker image is intended for testing purposes only, not production
use. An example pull request to update the docker image is
[here](https://github.com/apache/ozone-docker/pull/22/files). The target branch
for your pull request should be `latest`. After the pull request is merged, it
can be published to [Docker Hub](https://hub.docker.com/r/apache/ozone) by
updating the branches that correspond to [docker image
tags](https://hub.docker.com/r/apache/ozone/tags).
+The Ozone Docker image is intended for testing purposes only, not production
use. An example pull request to update the Docker image is
[here](https://github.com/apache/ozone-docker/pull/22/files). The target branch
for your pull request should be `latest`. After the pull request is merged, it
can be published to [Docker Hub](https://hub.docker.com/r/apache/ozone) by
updating the branches that correspond to [Docker image
tags](https://hub.docker.com/r/apache/ozone/tags).
1. Publish the image with the `latest` tag by fast-forwarding the
`ozone-latest` branch to match the `latest` branch.
@@ -424,7 +448,7 @@ The Ozone docker image is intended for testing purposes
only, not production use
Update the upgrade and client cross compatibility acceptance tests to check
against the new release. See [this pull
request](https://github.com/apache/ozone/pull/6040/files) for an example.
:::note
-This step requires the release's [docker
image](#publish-a-docker-image-for-the-release) to be published.
+This step requires the release's [Docker
image](#publish-a-docker-image-for-the-release) to be published.
:::
### Update the Ozone Roadmap
@@ -439,9 +463,9 @@ This step requires the release's [docker
image](#publish-a-docker-image-for-the-
Include the following links:
-- Release notes:
[https://ozone.apache.org/release/1.2.0/](https://ozone.apache.org/release/1.2.0/).
Replace the version in the URL with the version being released.
-- Download link:
[https://ozone.apache.org/downloads/](https://ozone.apache.org/downloads/)
-- Link to versioned documentation:
[https://ozone.apache.org/docs/](https://ozone.apache.org/docs/)
+- Release notes: https://ozone.apache.org/release/1.2.0/. Replace the version
in the URL with the version being released.
+- Download link: https://ozone.apache.org/downloads/
+- Link to versioned documentation: https://ozone.apache.org/docs/
## Patch Release
diff --git a/package.json b/package.json
index 981ceed2..909eaaec 100644
--- a/package.json
+++ b/package.json
@@ -29,7 +29,8 @@
"@cspell/dict-docker": "^1.1.7",
"@cspell/dict-java": "^5.0.6",
"@cspell/dict-markdown": "^2.0.1",
- "@cspell/dict-shell": "^1.0.6"
+ "@cspell/dict-shell": "^1.0.6",
+ "markdownlint-cli": "^0.39.0"
},
"browserslist": {
"production": [
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
index 7da582ed..ff3c22de 100644
--- a/pnpm-lock.yaml
+++ b/pnpm-lock.yaml
@@ -46,6 +46,9 @@ devDependencies:
cspell:
specifier: ^8.2.1
version: 8.4.1
+ markdownlint-cli:
+ specifier: ^0.39.0
+ version: 0.39.0
packages:
@@ -3530,7 +3533,6 @@ packages:
/[email protected]:
resolution: {integrity:
sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==}
- dev: false
/[email protected]:
resolution: {integrity:
sha512-PCVAQswWemu6UdxsDFFX/+gVeYqKAod3D3UVm91jHwynguOwAvYPhx8nNlM++NqRcK6CxxpUafjmhIdKiHibqg==}
@@ -3990,6 +3992,11 @@ packages:
engines: {node: '>=14'}
dev: false
+ /[email protected]:
+ resolution: {integrity:
sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==}
+ engines: {node: '>=16'}
+ dev: true
+
/[email protected]:
resolution: {integrity:
sha512-MwVNWlYjDTtOjX5PiD7o5pK0UrFU/OYgcJfjjK4RaHZETNtjJqrZa9Y9ds88+A+f+d5lv+561eZ+yCKoS3gbAA==}
engines: {node: '>=18'}
@@ -4538,7 +4545,6 @@ packages:
/[email protected]:
resolution: {integrity:
sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==}
engines: {node: '>=4.0.0'}
- dev: false
/[email protected]:
resolution: {integrity:
sha512-3sUqbMEc77XqpdNO7FRyRog+eW3ph+GYCbj+rK+uYyRMuwsVy0rMiVtPn+QJlKFvWP/1PYpapqYn0Me2knFn+A==}
@@ -4778,7 +4784,6 @@ packages:
/[email protected]:
resolution: {integrity:
sha512-V0hjH4dGPh9Ao5p0MoRY6BVqtwCjhz6vI5LT8AJ55H+4g9/4vbHx1I54fS0XuclLhDHArPQCiMjDxjaL8fPxhw==}
engines: {node: '>=0.12'}
- dev: false
/[email protected]:
resolution: {integrity:
sha512-7dFHNmqeFSEt2ZBsCriorKnn3Z2pj+fd9kmI6QoWw4//DL+icEBfc0U7qJCisqrTsKTjw4fNFy2pW9OqStD84g==}
@@ -5784,7 +5789,6 @@ packages:
/[email protected]:
resolution: {integrity:
sha512-g7dmpshy+gD7mh88OC9NwSGTKoc3kyLAZQRU1mt53Aw/vnvfXnbC+F/7F7QoYVKbV+KNvJx8wArewKy1vXMtlg==}
engines: {node: '>= 4'}
- dev: false
/[email protected]:
resolution: {integrity:
sha512-541xKlUw6jr/6gGuk92F+mYM5zaFAc5ahphvkqvNe2bQ6gVBkd6bfrmVJ2t4KDAfikAYZyIqTnktX3i6/aQDrQ==}
@@ -6122,7 +6126,6 @@ packages:
hasBin: true
dependencies:
argparse: 2.0.1
- dev: false
/[email protected]:
resolution: {integrity:
sha512-uZz5UnB7u4T9LvwmFqXii7pZSouaRPorGs5who1Ip7VO0wxanFvBL7GkM6dTHlgX+jhBApRetaWpnDabOeTcnA==}
@@ -6154,6 +6157,10 @@ packages:
hasBin: true
dev: false
+ /[email protected]:
+ resolution: {integrity:
sha512-AilxAyFOAcK5wA1+LeaySVBrHsGQvUFCDWXKpZjzaL0PqW+xfBOttn8GNtWKFWqneyMZj41MWF9Kl6iPWLwgOA==}
+ dev: true
+
/[email protected]:
resolution: {integrity:
sha512-5dgndWOriYSm5cnYaJNhalLNDKOqFwyDB/rr1E9ZsGciGvKPs8R2xYGCacuf3z6K1YKDz182fd+fY3cn3pMqXQ==}
dependencies:
@@ -6204,6 +6211,12 @@ packages:
resolution: {integrity:
sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==}
dev: false
+ /[email protected]:
+ resolution: {integrity:
sha512-5aHCbzQRADcdP+ATqnDuhhJ/MRIqDkZX5pyjFHRRysS8vZ5AbqGEoFIb6pYHPZ+L/OC2Lc+xT8uHVVR5CAK/wQ==}
+ dependencies:
+ uc.micro: 2.0.0
+ dev: true
+
/[email protected]:
resolution: {integrity:
sha512-3R/1M+yS3j5ou80Me59j7F9IMs4PXs3VqRrm0TU3AbKPxlmpoY1TNscJV/oGJXo8qCatFGTfDbY6W6ipGOYXfg==}
engines: {node: '>=6.11.5'}
@@ -6301,10 +6314,51 @@ packages:
resolution: {integrity:
sha512-o5vL7aDWatOTX8LzaS1WMoaoxIiLRQJuIKKe2wAw6IeULDHaqbiqiggmx+pKvZDb1Sj+pE46Sn1T7lCqfFtg1Q==}
engines: {node: '>=16'}
+ /[email protected]:
+ resolution: {integrity:
sha512-seFjF0FIcPt4P9U39Bq1JYblX0KZCjDLFFQPHpL5AzHpqPEKtosxmdq/LTVZnjfH7tjt9BxStm+wXcDBNuYmzw==}
+ hasBin: true
+ dependencies:
+ argparse: 2.0.1
+ entities: 4.5.0
+ linkify-it: 5.0.0
+ mdurl: 2.0.0
+ punycode.js: 2.3.1
+ uc.micro: 2.0.0
+ dev: true
+
/[email protected]:
resolution: {integrity:
sha512-Z1NL3Tb1M9wH4XESsCDEksWoKTdlUafKc4pt0GRwjUyXaCFZ+dc3g2erqB6zm3szA2IUSi7VnPI+o/9jnxh9hw==}
dev: false
+ /[email protected]:
+ resolution: {integrity:
sha512-ZuFN7Xpsbn1Nbp0YYkeLOfXOMOfLQBik2lKRy8pVI/llmKQ2uW7x+8k5OMgF6o7XCsTDSYC/OOmeJ+3qplvnJQ==}
+ engines: {node: '>=18'}
+ hasBin: true
+ dependencies:
+ commander: 11.1.0
+ get-stdin: 9.0.0
+ glob: 10.3.10
+ ignore: 5.3.0
+ js-yaml: 4.1.0
+ jsonc-parser: 3.2.1
+ markdownlint: 0.33.0
+ minimatch: 9.0.3
+ run-con: 1.3.2
+ dev: true
+
+ /[email protected]:
+ resolution: {integrity:
sha512-1ouYkMRo9/6gou9gObuMDnvZM8jC/ly3QCFQyoSPCS2XV1ZClU0xpKbL1Ar3bWWRT1RnBZkWUEiNKrI2CwiBQA==}
+ engines: {node: '>=16'}
+ dev: true
+
+ /[email protected]:
+ resolution: {integrity:
sha512-4lbtT14A3m0LPX1WS/3d1m7Blg+ZwiLq36WvjQqFGsX3Gik99NV+VXp/PW3n+Q62xyPdbvGOCfjPqjW+/SKMig==}
+ engines: {node: '>=18'}
+ dependencies:
+ markdown-it: 14.0.0
+ markdownlint-micromark: 0.1.8
+ dev: true
+
/[email protected]:
resolution: {integrity:
sha512-JUpYOqKI4mM3sZcNxmF/ox04XYFFkNwr0CFlrQIkCwbvH0xzMCqkMqAde9wRd80VAhaUrwFwKm2nxretdT1h7Q==}
dependencies:
@@ -6523,6 +6577,10 @@ packages:
resolution: {integrity:
sha512-dn6wd0uw5GsdswPFfsgMp5NSB0/aDe6fK94YJV/AJDYXL6HVLWBsxeq7js7Ad+mU2K9LAlwpk6kN2D5mwCPVow==}
dev: false
+ /[email protected]:
+ resolution: {integrity:
sha512-Lf+9+2r+Tdp5wXDXC4PcIBjTDtq4UKjCPMQhKIuzpJNW0b96kVqSwW0bT7FhRSfmAiFYgP+SCRvdrDozfh0U5w==}
+ dev: true
+
/[email protected]:
resolution: {integrity:
sha512-dq+qelQ9akHpcOl/gUVRTxVIOkAJ1wR3QAvb4RsVjS8oVoFjDGTc679wJYmUmknUF5HwMLOgb5O+a3KxfWapPQ==}
engines: {node: '>= 0.6'}
@@ -6979,7 +7037,6 @@ packages:
/[email protected]:
resolution: {integrity:
sha512-2yyAR8qBkN3YuheJanUpWC5U3bb5osDywNB8RzDVlDwDHbocAJveqqj1u8+SVD7jkWT4yvsHCpWqqWqAxb0zCA==}
- dev: false
/[email protected]:
resolution: {integrity:
sha512-jYofLM5Dam9279rdkWzqHozUo4ybjdZmCsDHePy5V/PbBcVMiSZR97gmAy45aqi8CK1lG2ECd356FU86avfwUQ==}
@@ -7858,6 +7915,11 @@ packages:
ipaddr.js: 1.9.1
dev: false
+ /[email protected]:
+ resolution: {integrity:
sha512-uxFIHU0YlHYhDQtV4R9J6a52SLx28BCjT+4ieh7IGbgwVJWO+km431c4yRlREUAsAmt/uMjQUyQHNEPf0M39CA==}
+ engines: {node: '>=6'}
+ dev: true
+
/[email protected]:
resolution: {integrity:
sha512-jmYNElW7yvO7TV33CjSmvSiE2yco3bV2czu/OzDKdMNVZQWfxCblURLhf+47syQRBntjfLdd/H0egrzIG+oaFQ==}
dev: false
@@ -8379,6 +8441,16 @@ packages:
strip-json-comments: 3.1.1
dev: false
+ /[email protected]:
+ resolution: {integrity:
sha512-CcfE+mYiTcKEzg0IqS08+efdnH0oJ3zV0wSUFBNrMHMuxCtXvBCLzCJHatwuXDcu/RlhjTziTo/a1ruQik6/Yg==}
+ hasBin: true
+ dependencies:
+ deep-extend: 0.6.0
+ ini: 4.1.1
+ minimist: 1.2.8
+ strip-json-comments: 3.1.1
+ dev: true
+
/[email protected]:
resolution: {integrity:
sha512-5l4VyZR86LZ/lDxZTR6jqL8AFE2S0IFLMP26AbjsLVADxHdhB/c0GUsH+y39UfCi3dzz8OlQuPmnaJOMoDHQBA==}
dependencies:
@@ -8820,7 +8892,6 @@ packages:
/[email protected]:
resolution: {integrity:
sha512-6fPc+R4ihwqP6N/aIv2f1gMH8lOVtWQHoqC4yK6oSDVVocumAsfCqjkXnqiYMhmMwS/mEHLp7Vehlt3ql6lEig==}
engines: {node: '>=8'}
- dev: false
/[email protected]:
resolution: {integrity:
sha512-HYNoHZa2GorYNyqiCaBgsxvcJIn7OHq6inEga+E6Ke3m5JkoqpQbnFssk4jwe+K7AhGa2fcha4wSOf1Kn01dMg==}
@@ -9003,6 +9074,10 @@ packages:
hasBin: true
dev: false
+ /[email protected]:
+ resolution: {integrity:
sha512-DffL94LsNOccVn4hyfRe5rdKa273swqeA5DJpMOeFmEn1wCDc7nAbbB0gXlgBCL7TNzeTv6G7XVWzan7iJtfig==}
+ dev: true
+
/[email protected]:
resolution: {integrity:
sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==}
diff --git a/src/pages/community/communication-channels.md
b/src/pages/community/communication-channels.md
index 2f9307b7..b92de047 100644
--- a/src/pages/community/communication-channels.md
+++ b/src/pages/community/communication-channels.md
@@ -3,6 +3,7 @@
**TODO [HDDS-9618](https://issues.apache.org/jira/browse/HDDS-9618) Fill in
this page.**
Add links and sign up instructions for all the ways to get in contact with
Ozone developers and users. This includes:
+
- Apache mailing lists
- Community Meetings
- Github Discussions
diff --git a/src/pages/community/how-to-contribute.md
b/src/pages/community/how-to-contribute.md
index 2c157928..198065aa 100644
--- a/src/pages/community/how-to-contribute.md
+++ b/src/pages/community/how-to-contribute.md
@@ -3,9 +3,10 @@
**TODO [HDDS-9869](https://issues.apache.org/jira/browse/HDDS-9869) Fill in
this page.**
This may end up similar to CONTRIBUTING.md in the Ozone repo, but should
document all the ways to contribute outside of code as well.
+
- Testing and filing issues
- - This may link to the [Report an Issue](report-an-issue) page.
+ - This may link to the [Report an Issue](report-an-issue) page.
- Contributing code
- - Both Ozone backend and Recon UI/UX front end.
+ - Both Ozone backend and Recon UI/UX front end.
- Contributing to the website
- Graphic design work for logos or diagrams.
diff --git a/src/pages/download.md b/src/pages/download.md
index 93c7dac3..91ecf8fc 100644
--- a/src/pages/download.md
+++ b/src/pages/download.md
@@ -3,6 +3,7 @@
**TODO [HDDS-9616](https://issues.apache.org/jira/browse/HDDS-9616) Fill in
this page.**
Fill this in similar to what is on the current website.
+
- Create in a table with all release information from 1.0.0-1.3.0 (example
below).
- Include instructions for verifying signatures and checksums.
- Include license information.
@@ -11,4 +12,3 @@ Fill this in similar to what is on the current website.
| Version | Release Date | Source Download | Binary Download | Release Notes |
|-|-|-|-|-|
| 1.3.0 | 2022 Dec 18 |
[Source](https://www.apache.org/dyn/closer.cgi/ozone/1.3.0/ozone-1.3.0-src.tar.gz)<br/>[Checksum](https://downloads.apache.org/ozone/1.3.0/ozone-1.3.0-src.tar.gz.sha512)<br/>[Signature](https://downloads.apache.org/ozone/1.3.0/ozone-1.3.0-src.tar.gz.asc)
|
[Binary](https://www.apache.org/dyn/closer.cgi/ozone/1.3.0/ozone-1.3.0.tar.gz)<br/>[Checksum](https://downloads.apache.org/ozone/1.3.0/ozone-1.3.0.tar.gz.sha512)<br/>[Signature](https://downloads.apache.org/ozon
[...]
-
diff --git a/src/pages/release-notes/1.0.0.md b/src/pages/release-notes/1.0.0.md
index faf92bbb..5ace2d9c 100644
--- a/src/pages/release-notes/1.0.0.md
+++ b/src/pages/release-notes/1.0.0.md
@@ -1,4 +1,3 @@
# Apache Ozone 1.0.0 Release Notes
**TODO [HDDS-9617](https://issues.apache.org/jira/browse/HDDS-9617) Fill in
this page.**
-
diff --git a/src/pages/release-notes/1.1.0.md b/src/pages/release-notes/1.1.0.md
index 799650ba..73b5ad62 100644
--- a/src/pages/release-notes/1.1.0.md
+++ b/src/pages/release-notes/1.1.0.md
@@ -1,4 +1,3 @@
# Apache Ozone 1.1.0 Release Notes
**TODO [HDDS-9617](https://issues.apache.org/jira/browse/HDDS-9617) Fill in
this page.**
-
diff --git a/src/pages/release-notes/1.2.1.md b/src/pages/release-notes/1.2.1.md
index acdeac1a..42d356db 100644
--- a/src/pages/release-notes/1.2.1.md
+++ b/src/pages/release-notes/1.2.1.md
@@ -1,4 +1,3 @@
# Apache Ozone 1.2.1 Release Notes
**TODO [HDDS-9617](https://issues.apache.org/jira/browse/HDDS-9617) Fill in
this page.**
-
diff --git a/src/pages/release-notes/1.3.0.md b/src/pages/release-notes/1.3.0.md
index 33bc5380..7b39464e 100644
--- a/src/pages/release-notes/1.3.0.md
+++ b/src/pages/release-notes/1.3.0.md
@@ -1,4 +1,3 @@
# Apache Ozone 1.3.0 Release Notes
**TODO [HDDS-9617](https://issues.apache.org/jira/browse/HDDS-9617) Fill in
this page.**
-
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
