From 506d1c8368db291976514453b25f0ff5abf5e74f Mon Sep 17 00:00:00 2001 From: HyoBin Kim Date: Tue, 8 Apr 2025 14:25:47 +0900 Subject: [PATCH] feat: Draft initial SUMMARY.md structure Initial draft of the SUMMARY.md file Signed-off-by: HyoBin Kim --- src/SUMMARY.md | 191 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 191 insertions(+) diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 2afd2e0..1cbd710 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -1,3 +1,194 @@ # Summary +- [Intro to Ceph](./intro-to-ceph.md) + - [Beginner's Guide](./intro-to-ceph/beginners-guide.md) + - [Hardware Recommendations](./intro-to-ceph/hardware-recommendations.md) + - [OS Recommendations](./intro-to-ceph/os-recommendations.md) + - [Get Involved in the Ceph Community!](./intro-to-ceph/get-involved.md) + - [Documenting Ceph](./intro-to-ceph/documenting-ceph.md) +- [Installing Ceph](./installing-ceph.md) + - [Recommended methods](./installing-ceph/recommended.md) + - [Other methods](./installing-ceph/other.md) + - [Windows](./installing-ceph/windows.md) +- [Cephadm](./cephadm.md) + - [Compatibility and Stability](./cephadm/compatibility.md) + - [Using cephadm to Deploy a New Ceph Cluster](./cephadm/deploy.md) + - [Converting an existing cluster to cephadm](./cephadm/convert.md) + - [Host Management](./cephadm/host-management.md) + - [Service Management](./cephadm/service-management.md) + - [Upgrading Ceph](./cephadm/upgrading.md) + - [Cephadm operations](./cephadm/operations.md) + - [Client Setup](./cephadm/client-setup.md) + - [Troubleshooting](./cephadm/troubleshooting.md) + - [Cephadm Feature Planning](./cephadm/feature-planning.md) +- [Ceph Storage Cluster](./ceph-storage-cluster.md) + - [Configuration](./ceph-storage-cluster/configuration.md) + - [Operations](./ceph-storage-cluster/operations.md) + - [Man Pages](./ceph-storage-cluster/manpages.md) + - [Troubleshooting](./ceph-storage-cluster/troubleshooting.md) + - [APIs](./ceph-storage-cluster/apis.md) +- [Ceph File System](./ceph-file-system.md) + - [Getting Started with CephFS](./ceph-file-system/getting-started.md) + - [Administration](./ceph-file-system/administration.md) + - [Mounting CephFS](./ceph-file-system/mounting.md) + - [CephFS Concepts](./ceph-file-system/concepts.md) + - [Troubleshooting and Disaster Recovery](./ceph-file-system/troubleshooting.md) + - [Developer Guides](./ceph-file-system/developer-guides.md) + - [Additional Details](./ceph-file-system/additional-details.md) +- [Ceph Block Device](./ceph-block-device.md) + - [Basic Commands](./ceph-block-device/basic-commands.md) + - [Operations](./ceph-block-device/operations.md) + - [Integrations](./ceph-block-device/integrations.md) + - [Manpages](./ceph-block-device/manpages.md) + - [APIs](./ceph-block-device/apis.md) +- [Ceph Object Gateway](./ceph-object-gateway.md) + - [HTTP Frontends](./ceph-object-gateway/http-frontends.md) + - [Multisite Configuration](./ceph-object-gateway/multisite-config.md) + - [Pool Placement and Storage Classes](./ceph-object-gateway/pool-placement.md) + - [Multisite Sync Policy Configuration](./ceph-object-gateway/multisite-sync-policy.md) + - [Configuring Pools](./ceph-object-gateway/configuring-pools.md) + - [Config Reference](./ceph-object-gateway/config-reference.md) + - [Admin Guide](./ceph-object-gateway/admin-guide.md) + - [S3 API](./ceph-object-gateway/s3-api.md) + - [Data caching and CDN](./ceph-object-gateway/caching-cdn.md) + - [Swift API](./ceph-object-gateway/swift-api.md) + - [Admin Ops API](./ceph-object-gateway/admin-ops-api.md) + - [Python binding](./ceph-object-gateway/python-binding.md) + - [Export over NFS](./ceph-object-gateway/export-nfs.md) + - [OpenStack Keystone Integration](./ceph-object-gateway/keystone-integration.md) + - [OpenStack Barbican Integration](./ceph-object-gateway/barbican-integration.md) + - [HashiCorp Vault Integration](./ceph-object-gateway/vault-integration.md) + - [KMIP Integration](./ceph-object-gateway/kmip-integration.md) + - [Open Policy Agent Integration](./ceph-object-gateway/opa-integration.md) + - [Multi-tenancy](./ceph-object-gateway/multi-tenancy.md) + - [Compression](./ceph-object-gateway/compression.md) + - [LDAP Authentication](./ceph-object-gateway/ldap-auth.md) + - [Server-Side Encryption](./ceph-object-gateway/server-side-encryption.md) + - [Bucket Policy](./ceph-object-gateway/bucket-policy.md) + - [Dynamic bucket index resharding](./ceph-object-gateway/dynamic-resharding.md) + - [Multi factor authentication](./ceph-object-gateway/mfa.md) + - [Sync Modules](./ceph-object-gateway/sync-modules.md) + - [Bucket Notifications](./ceph-object-gateway/bucket-notifications.md) + - [Data Layout in RADOS](./ceph-object-gateway/data-layout.md) + - [STS](./ceph-object-gateway/sts.md) + - [STS Lite](./ceph-object-gateway/sts-lite.md) + - [Keycloak](./ceph-object-gateway/keycloak.md) + - [Session Tags](./ceph-object-gateway/session-tags.md) + - [Role](./ceph-object-gateway/role.md) + - [Orphan List and Associated Tooling](./ceph-object-gateway/orphan-list.md) + - [OpenID Connect Provider](./ceph-object-gateway/oidc.md) + - [Troubleshooting](./ceph-object-gateway/troubleshooting.md) + - [Manpage radosgw](./ceph-object-gateway/manpage-radosgw.md) + - [Manpage radosgw-admin](./ceph-object-gateway/manpage-radosgw-admin.md) + - [QAT Acceleration for Encryption and Compression](./ceph-object-gateway/qat-acceleration.md) + - [S3-select](./ceph-object-gateway/s3-select.md) + - [Lua Scripting](./ceph-object-gateway/lua-scripting.md) + - [D3N Data Cache](./ceph-object-gateway/d3n-cache.md) + - [Cloud Transition](./ceph-object-gateway/cloud-transition.md) +- [Ceph Manager Daemon](./ceph-manager-daemon.md) + - [Installation and Configuration](./ceph-manager-daemon/install-config.md) + - [Writing modules](./ceph-manager-daemon/writing-modules.md) + - [Writing orchestrator plugins](./ceph-manager-daemon/writing-orchestrator-plugins.md) + - [Dashboard module](./ceph-manager-daemon/dashboard-module.md) + - [Ceph RESTful API](./ceph-manager-daemon/restful-api.md) + - [Alerts module](./ceph-manager-daemon/alerts-module.md) + - [DiskPrediction module](./ceph-manager-daemon/diskprediction-module.md) + - [Local pool module](./ceph-manager-daemon/localpool-module.md) + - [RESTful module](./ceph-manager-daemon/restful-module.md) + - [Zabbix module](./ceph-manager-daemon/zabbix-module.md) + - [Prometheus module](./ceph-manager-daemon/prometheus-module.md) + - [Influx module](./ceph-manager-daemon/influx-module.md) + - [Hello module](./ceph-manager-daemon/hello-module.md) + - [Telegraf module](./ceph-manager-daemon/telegraf-module.md) + - [Telemetry module](./ceph-manager-daemon/telemetry-module.md) + - [Iostat module](./ceph-manager-daemon/iostat-module.md) + - [Crash module](./ceph-manager-daemon/crash-module.md) + - [Insights module](./ceph-manager-daemon/insights-module.md) + - [Orchestrator module](./ceph-manager-daemon/orchestrator-module.md) + - [Rook module](./ceph-manager-daemon/rook-module.md) + - [RGW module](./ceph-manager-daemon/rgw-module.md) + - [MDS Autoscaler module](./ceph-manager-daemon/mds-autoscaler-module.md) + - [NFS module](./ceph-manager-daemon/nfs-module.md) + - [Progress Module](./ceph-manager-daemon/progress-module.md) + - [CLI API Commands module](./ceph-manager-daemon/cli-api-commands-module.md) +- [Ceph Dashboard](./ceph-dashboard.md) + - [Overview](./ceph-dashboard/overview.md) + - [Enabling](./ceph-dashboard/enabling.md) + - [Configuration](./ceph-dashboard/configuration.md) + - [User and Role Management](./ceph-dashboard/user-role-management.md) + - [Proxy Configuration](./ceph-dashboard/proxy-configuration.md) + - [Auditing API Requests](./ceph-dashboard/auditing-api-requests.md) + - [NFS-Ganesha Management](./ceph-dashboard/nfs-ganesha-management.md) + - [Plug-ins](./ceph-dashboard/plugins.md) + - [Troubleshooting the Dashboard](./ceph-dashboard/troubleshooting.md) +- [Monitoring overview](./monitoring-overview.md) + - [Ceph Monitoring stack](./monitoring-overview/monitoring-stack.md) + - [Ceph metrics](./monitoring-overview/ceph-metrics.md) + - [Ceph daemon health metrics](./monitoring-overview/daemon-health-metrics.md) + - [Performance metrics](./monitoring-overview/performance-metrics.md) + - [OSD performance](./monitoring-overview/osd-performance.md) + - [Physical storage drive performance](./monitoring-overview/physical-drive-performance.md) + - [Pool metrics](./monitoring-overview/pool-metrics.md) + - [RGW metrics](./monitoring-overview/rgw-metrics.md) + - [CephFS Metrics](./monitoring-overview/cephfs-metrics.md) + - [Block metrics](./monitoring-overview/block-metrics.md) + - [Hardware monitoring](./monitoring-overview/hardware-monitoring.md) +- [API Documentation](./api-documentation.md) + - [Ceph RESTful API](./api-documentation/restful-api.md) + - [Ceph Storage Cluster APIs](./api-documentation/storage-cluster-apis.md) + - [Ceph File System APIs](./api-documentation/file-system-apis.md) + - [Ceph Block Device APIs](./api-documentation/block-device-apis.md) + - [Ceph RADOS Gateway APIs](./api-documentation/rados-gateway-apis.md) + - [Ceph Object Store APIs](./api-documentation/object-store-apis.md) + - [Ceph MON Command API](./api-documentation/mon-command-api.md) - [Architecture](./architecture.md) +- [Developer Guide](./developer-guide.md) + - [Introduction](./developer-guide/introduction.md) + - [Essentials](./developer-guide/essentials.md) + - [What is Merged and When](./developer-guide/merge-process.md) + - [Issue tracker](./developer-guide/issue-tracker.md) + - [Basic workflow](./developer-guide/basic-workflow.md) + - [Tests: Unit Tests](./developer-guide/tests-unit.md) + - [Tests: Integration Tests (Teuthology)](./developer-guide/tests-integration.md) + - [Tests: Running Tests (Locally)](./developer-guide/tests-local.md) + - [Tests: Windows](./developer-guide/tests-windows.md) + - [Ceph Dashboard Developer Documentation (formerly HACKING.rst)](./developer-guide/dashboard-dev-docs.md) + - [Tracing Developer Documentation](./developer-guide/tracing-dev-docs.md) + - [Cephadm Developer Documentation](./developer-guide/cephadm-dev-docs.md) + - [Debugging with GDB](./developer-guide/debugging-gdb.md) +- [Ceph Internals](./ceph-internals.md) + - [Starting a Development-mode Ceph Cluster](./ceph-internals/dev-mode-cluster.md) +- [Governance](./governance.md) + - [Key principles](./governance/key-principles.md) + - [Ceph Executive Council](./governance/executive-council.md) + - [Ceph Steering Committee](./governance/steering-committee.md) + - [Component Team Leads](./governance/team-leads.md) +- [Ceph Foundation](./ceph-foundation.md) + - [Members](./ceph-foundation/members.md) + - [Governing Board](./ceph-foundation/governing-board.md) + - [Joining](./ceph-foundation/joining.md) +- [ceph-volume](./ceph-volume.md) + - [Migrating](./ceph-volume/migrating.md) +- [Ceph Releases (general)](./ceph-releases-general.md) + - [Understanding the release cycle](./ceph-releases-general/release-cycle.md) + - [Lifetime of stable releases](./ceph-releases-general/stable-release-lifetime.md) +- [Ceph Releases (index)](./ceph-releases-index.md) + - [Active Releases](./ceph-releases-index/active-releases.md) + - [Archived Releases](./ceph-releases-index/archived-releases.md) + - [Release timeline](./ceph-releases-index/release-timeline.md) +- [Security](./security.md) + - [Past Vulnerabilities / CVEs](./security/past-vulnerabilities.md) + - [Vulnerability Management Process](./security/vulnerability-management.md) + - [Reporting a vulnerability](./security/reporting-vulnerability.md) + - [Supported versions](./security/supported-versions.md) +- [Hardware monitoring](./hardware-monitoring.md) + - [Limitations](./hardware-monitoring/limitations.md) + - [Deploying the agent](./hardware-monitoring/deploying-the-agent.md) + - [CLI](./hardware-monitoring/cli.md) + - [Developpers](./hardware-monitoring/developpers.md) +- [Glossary](./glossary.md) +- [Tracing](./tracing.md) + - [Basic Architecture and Terminology](./tracing/basic-architecture.md) + - [Jaeger Deployment](./tracing/jaeger-deployment.md) + - [How to Enable Tracing in Ceph](./tracing/enable-ceph.md) + - [Traces in RGW](./tracing/rgw.md)