-
Notifications
You must be signed in to change notification settings - Fork 381
WIP: restructure docs navigation #9200
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | |
---|---|---|---|
|
@@ -108,7 +108,11 @@ plugins: | ||
allow_arbitrary_locations : true | |||
- meta | |||
|
|||
# This section is used to generate the navigation sidebar | |||
|
|||
|
|||
############################################################ | |||
# This section is used to generate the navigation sidebar # | |||
############################################################ | |||
nav: | |||
- Welcome to lakeFS: index.md | |||
- Quickstart: | |||
|
@@ -121,129 +125,136 @@ nav: | ||
- "6\uFE0F\u20E3 Using Actions and Hooks in lakeFS": quickstart/actions-and-hooks.md | |||
- "7\uFE0F\u20E3 Work with lakeFS data locally": quickstart/work-with-data-locally.md | |||
- Learn more about lakeFS: quickstart/learning-more-lakefs.md | |||
- How-To: | |||
- Use Cases: | |||
- CI/CD for Data Lakes: understand/use_cases/cicd_for_data.md | |||
- ETL Testing Environment: understand/use_cases/etl_testing.md | |||
- Reproducibility: understand/use_cases/reproducibility.md | |||
- User Guides: | |||
- Install lakeFS: | |||
- Overview: howto/deploy/index.md | |||
- AWS: howto/deploy/aws.md | |||
- Azure: howto/deploy/azure.md | |||
- GCP: howto/deploy/gcp.md | |||
- On-Premises: howto/deploy/onprem.md | |||
- Upgrade lakeFS: howto/deploy/upgrade.md | |||
- Upgrade lakeFS: howto/deploy/upgrade.md | |||
- Sizing Guide: howto/sizing-guide.md | |||
- Data Management: | |||
- Git-Like Versioning: | |||
- Pull Requests: howto/pull-requests.md | |||
- Branch Protection: howto/protect-branches.md | |||
- Rollback & Revert: understand/use_cases/rollback.md | |||
- Merge Strategies: understand/how/merge.md | |||
- Import & Export Data: | |||
- Importing Data: howto/import.md | |||
- Export Data: howto/export.md | |||
- Copying data to/from lakeFS: howto/copying.md | |||
- Data Catalogs Exports: howto/catalog_exports.md | |||
- Work with Data locally: howto/local-checkouts.md | |||
- Actions and Hooks: | |||
- Overview: howto/hooks/index.md | |||
- Airflow Hooks: howto/hooks/airflow.md | |||
- Lua Hooks: howto/hooks/lua.md | |||
- Webhooks: howto/hooks/webhooks.md | |||
- Backup and Restore Repository: howto/backup-and-restore.md | |||
- Branch Protection: howto/protect-branches.md | |||
- Copying data to/from lakeFS: howto/copying.md | |||
- Data Catalogs Exports: howto/catalog_exports.md | |||
- Export Data: howto/export.md | |||
- Garbage Collection: | |||
- Garbage Collection: howto/garbage-collection/gc.md | |||
- Overview: howto/garbage-collection/gc.md | |||
- Managed Garbage Collection: howto/garbage-collection/managed-gc.md | |||
- Standalone Garbage Collection: howto/garbage-collection/standalone-gc.md | |||
- Import Data: howto/import.md | |||
- Migrating away from lakeFS: howto/migrate-away.md | |||
- Mirroring: howto/mirroring.md | |||
- Multiple Storage Backend: howto/multiple-storage-backends.md | |||
- Private Link: howto/private-link.md | |||
- Pull Requests: howto/pull-requests.md | |||
- S3 Virtual-host addressing (advanced): howto/virtual-host-addressing.md | |||
- Sizing Guide: howto/sizing-guide.md | |||
- System for Cross-domain Identity Management (SCIM): howto/scim.md | |||
- Work with lakeFS data locally: howto/local-checkouts.md | |||
- Multiple Storage Backends: howto/multiple-storage-backends.md | |||
- Transactional Mirroring: howto/mirroring.md | |||
- Backup and Restore: howto/backup-and-restore.md | |||
- Advanced Operations: | |||
- Private Link: howto/private-link.md | |||
- S3 Virtual-host addressing: howto/virtual-host-addressing.md | |||
- Mount: | |||
- Overview: reference/mount.md | |||
- Mount CSI Driver: reference/mount-csi-driver.md | |||
- Mount Write Mode Semantics: reference/mount-write-mode-semantics.md | |||
- Monitoring & Auditing: | |||
- Monitoring using Prometheus: reference/monitor.md | |||
- Auditing: reference/auditing.md | |||
- Migrating away from lakeFS: howto/migrate-away.md | |||
- lakeFS Enterprise: | |||
- Overview: | |||
- Features: enterprise/index.md | |||
- Deployment Options: enterprise/deployment-options.md | |||
- Enterprise Support: enterprise/enterprise-support.md | |||
- lakeFS Cloud: cloud/index.md | |||
- On-Premises: | |||
- Quickstart: enterprise/getstarted/quickstart.md | |||
- Install: enterprise/getstarted/install.md | |||
- Migrate from lakeFS OSS: enterprise/getstarted/migrate-from-oss.md | |||
- Upgrading: enterprise/upgrade.md | |||
- Architecture: enterprise/architecture.md | |||
- Troubleshooting: enterprise/troubleshooting.md | |||
- Configuration Reference: enterprise/configuration.md | |||
- Integrations: | |||
- Overview: integrations/index.md | |||
- AWS CLI: integrations/aws_cli.md | |||
- Airbyte: integrations/airbyte.md | |||
- Amazon Athena: integrations/athena.md | |||
- Amazon SageMaker: integrations/sagemaker.md | |||
- Apache Airflow: integrations/airflow.md | |||
- Apache Hive: integrations/hive.md | |||
- Apache Iceberg: integrations/iceberg.md | |||
- Apache Kafka: integrations/kafka.md | |||
- Apache Spark: integrations/spark.md | |||
- Cloudera: integrations/cloudera.md | |||
- Databricks: integrations/databricks.md | |||
- Delta Lake: integrations/delta.md | |||
- Dremio: integrations/dremio.md | |||
- DuckDB: integrations/duckdb.md | |||
- Git: integrations/git.md | |||
- Glue / Hive metastore: integrations/glue_hive_metastore.md | |||
- Glue Data Catalog: integrations/glue_metastore.md | |||
- HuggingFace Datasets: integrations/huggingface_datasets.md | |||
- Kubeflow: integrations/kubeflow.md | |||
- MLflow: integrations/mlflow.md | |||
- Presto / Trino: integrations/presto_trino.md | |||
- Python: integrations/python.md | |||
- R: integrations/r.md | |||
- Red Hat OpenShift AI: integrations/red_hat_openshift_ai.md | |||
- Unity Catalog: integrations/unity-catalog.md | |||
- Vertex AI: integrations/vertex_ai.md | |||
- Understanding lakeFS: | |||
- Overview: understand/index.md | |||
- Data Processing & Compute: | |||
- Apache Spark: integrations/spark.md | |||
- Apache Iceberg: integrations/iceberg.md | |||
- Apache Hive: integrations/hive.md | |||
- Presto / Trino: integrations/presto_trino.md | |||
- Dremio: integrations/dremio.md | |||
- Databricks: integrations/databricks.md | |||
- Cloudera: integrations/cloudera.md | |||
- DuckDB: integrations/duckdb.md | |||
- Delta Lake: integrations/delta.md | |||
- Amazon Athena: integrations/athena.md | |||
- Apache Kafka: integrations/kafka.md | |||
- ML & AI: | |||
- Amazon SageMaker: integrations/sagemaker.md | |||
- Vertex AI: integrations/vertex_ai.md | |||
- Red Hat OpenShift AI: integrations/red_hat_openshift_ai.md | |||
- HuggingFace Datasets: integrations/huggingface_datasets.md | |||
- MLflow: integrations/mlflow.md | |||
- Kubeflow: integrations/kubeflow.md | |||
- Catalogs & Metadata: | |||
- Iceberg REST Catalog: integrations/iceberg-rest-catalog.md | |||
- Glue Data Catalog: integrations/glue_metastore.md | |||
- Glue / Hive metastore: integrations/glue_hive_metastore.md | |||
- Unity Catalog: integrations/unity-catalog.md | |||
- Orchestration & ETL: | |||
- Apache Airflow: integrations/airflow.md | |||
- Airbyte: integrations/airbyte.md | |||
- Dev & Tools: | |||
- Python: integrations/python.md | |||
- AWS CLI: integrations/aws_cli.md | |||
- Git: integrations/git.md | |||
- R: integrations/r.md | |||
- Concepts: | |||
- Architecture: understand/architecture.md | |||
- Concepts and Model: understand/model.md | |||
- Data Lifecycle Management: | |||
- Overview: understand/data_lifecycle_management/index.md | |||
- In Test: understand/data_lifecycle_management/data-devenv.md | |||
- During Deployment: understand/data_lifecycle_management/ci.md | |||
- In Production: understand/data_lifecycle_management/production.md | |||
- Model: understand/model.md | |||
- Data Structure: understand/data-structure.md | |||
- Performance Best Practices: understand/performance-best-practices.md | |||
- Internals: | |||
- Versioning Internals: understand/how/versioning-internals.md | |||
- Database structure: understand/how/kv.md | |||
- FAQ: understand/faq.md | |||
- Glossary: understand/glossary.md | |||
- How lakeFS Works: | |||
- Overview: understand/how/index.md | |||
- Internal database structure: understand/how/kv.md | |||
- Merge: understand/how/merge.md | |||
- Versioning Internals: understand/how/versioning-internals.md | |||
- Performance Best Practices: understand/performance-best-practices.md | |||
- Use Cases: | |||
- Overview: understand/use_cases/index.md | |||
- CI/CD for Data Lakes: understand/use_cases/cicd_for_data.md | |||
- ETL Testing Environment: understand/use_cases/etl_testing.md | |||
- Reproducibility: understand/use_cases/reproducibility.md | |||
- Rollback: understand/use_cases/rollback.md | |||
- Security: | |||
- Overview: security/index.md | |||
- Authentication: | |||
- Authentication: security/authentication.md | |||
- Single Sign On (SSO): security/sso.md | |||
- AWS IAM Roles: security/external-principals-aws.md | |||
- Remote Authenticator: security/remote-authenticator.md | |||
- Short-Lived Tokens (STS): security/sts-login.md | |||
- SCIM: howto/scim.md | |||
- Authorization: | |||
- Role-Based Access Control (RBAC): security/rbac.md | |||
- Access Control Lists (ACLs): security/access-control-lists.md | |||
- ACL Server Implementation: security/ACL-server-implementation.md | |||
- Presigned URLs: security/presigned-url.md | |||
|
|||
- Reference: | |||
- Overview: reference/index.md | |||
- Mount: | |||
- Overview: reference/mount.md | |||
- Mount CSI Driver: reference/mount-csi-driver.md | |||
- Mount Write Mode Semantics: reference/mount-write-mode-semantics.md | |||
- Auditing: reference/auditing.md | |||
- Monitoring using Prometheus: reference/monitor.md | |||
- S3 Gateway API: reference/s3.md | |||
- Spark Client: reference/spark-client.md | |||
- lakeFS API: reference/api.md | |||
- lakeFS Server Configuration: reference/configuration.md | |||
- lakectl (lakeFS command-line tool): reference/cli.md | |||
- The lakeFS Project: | |||
- Overview: project/index.md | |||
- Contributing to lakeFS: project/contributing.md | |||
- Documentation: project/docs.md | |||
- Migrating to 1.0: project/code-migrate-1.0-sdk.md | |||
- lakeFS Cloud: cloud/index.md | |||
- lakeFS Enterprise: | |||
- Overview: enterprise/index.md | |||
- Get Started: | |||
- Overview: enterprise/getstarted/index.md | |||
- Quickstart: enterprise/getstarted/quickstart.md | |||
- Install: enterprise/getstarted/install.md | |||
- Migrate from lakeFS OSS: enterprise/getstarted/migrate-from-oss.md | |||
- Upgrade: enterprise/upgrade.md | |||
- Troubleshooting lakeFS Enterprise: enterprise/troubleshooting.md | |||
- Configuration Reference: enterprise/configuration.md | |||
- Architecture: enterprise/architecture.md | |||
- Security: | |||
- Overview: security/index.md | |||
- ACL Server Implementation: security/ACL-server-implementation.md | |||
- Access Control Lists (ACLs): security/access-control-lists.md | |||
- Authentication: security/authentication.md | |||
- lakeFS Server Configuration: reference/configuration.md | |||
- S3 Gateway API: reference/s3.md | |||
- Spark Client: reference/spark-client.md | |||
- Authorization API: security/authorization-yaml.md | |||
- Login to lakeFS with AWS IAM Roles: security/external-principals-aws.md | |||
- Presigned URLs: security/presigned-url.md | |||
- Remote Authenticator: security/remote-authenticator.md | |||
- Role-Based Access Control (RBAC): security/rbac.md | |||
- Short-lived token (STS like) Authentication for lakeFS: security/sts-login.md | |||
- Single Sign On (SSO): security/sso.md | |||
- The lakeFS Project: | |||
- About: project/index.md | |||
- Contributing to lakeFS: | |||
- Code: project/contributing.md | |||
- Documentation: project/docs.md | |||
Comment on lines
+255
to
+259
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Looking for a different section name as I expected the information about lakeFS as part of the first items in the nav.
|
|||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -46,9 +46,9 @@ Using lakeFS cloud is not just a secure and managed way of using lakeFS OSS; it | |
|
||
1. [lakeFS Mount](../reference/mount.md) allows users to virtually mount a remote lakeFS repository onto a local directory. Once mounted, users can access the data as if it resides on their local filesystem, using any tool, library, or framework that reads from a local filesystem. | ||
1. [lakeFS Metadata Search](https://info.lakefs.io/metadata-search) - Allows a granular search API to filter and query versioned objects based on attached metadata. This is especially useful for machine learning environments to filter by labels and file attributes | ||
1. [lakeFS for Databricks](https://lakefs.io/lakefs-for-databricks) - Provides a turnkey solution for Databricks customers for analytics, machine learning and business intelligence use cases including full support for Delta Lake tables, Unity Catalog, MLFlow and the rest of the Databricks product suite. | ||
1. [Iceberg REST Catalog](../integrations/iceberg.md) - Provides full support for managing Iceberg tables alongside other data formats in the same lakeFS repository. Built using open standards and works with any Iceberg client. | ||
1. [lakeFS for Snowflake](https://info.lakefs.io/lakefs-for-snowflake) - Provides full integration into the Snowflake ecosystem, including full support for Iceberg managed tables. | ||
1. [lakeFS Cross Cloud](https://info.lakefs.io/cross-cloud) - Allows central management of repositories that span across multiple cloud providers including Azure, AWS, GCP and on-prem environments. | ||
1. [lakeFS Cross-Cloud](https://info.lakefs.io/cross-cloud) - Allows central management of repositories that span across multiple cloud providers including Azure, AWS, GCP and on-prem environments. | ||
1. [Transactional Mirroring](../howto/mirroring.md) - allows replicating lakeFS repositories into consistent read-only copies in remote locations. | ||
|
||
|
||
|
@@ -62,20 +62,19 @@ Using lakeFS cloud is not just a secure and managed way of using lakeFS OSS; it | |
| **Configurable Garbage Collection** | ✅ | ✅ | | ||
| **Data CI/CD using lakeFS hooks** | ✅ | ✅ | | ||
| **Integrates with your data stack** | ✅ | ✅ | | ||
| **[Role Based Access Control (RBAC)](https://docs.lakefs.io/security/rbac.html)** | | ✅ | | ||
| **[Single Sign On (SSO)](https://docs.lakefs.io/security/sso.html)** | | ✅ | | ||
| **[SCIM Support](https://docs.lakefs.io/howto/scim.html)** | | ✅ | | ||
| **[IAM Roles](https://docs.lakefs.io/security/external-principals-aws.html)** | | ✅ | | ||
| **[Mount Capability](https://docs.lakefs.io/reference/mount.html)** | | ✅ | | ||
| **[Audit Logs](https://docs.lakefs.io/reference/auditing.html)** | | ✅ | | ||
| **[Transactional Mirroring (cross-region)](https://docs.lakefs.io/howto/mirroring.html)** | | ✅ | | ||
| **[Role Based Access Control (RBAC)](../security/rbac.md)** | | ✅ | | ||
| **[Single Sign On (SSO)](../security/sso.md)** | | ✅ | | ||
| **[SCIM Support](../howto/scim.md)** | | ✅ | | ||
| **[IAM Roles](../security/external-principals-aws.md)** | | ✅ | | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. AWS |
||
| **[Mount Capability](../reference/mount.md)** | | ✅ | | ||
| **[Audit Logs](../reference/auditing.md)** | | ✅ | | ||
| **[Transactional Mirroring (cross-region)](../howto/mirroring.md)** | | ✅ | | ||
| **Managed Service (auto updates, scaling)** | | ✅ | | ||
| **[Managed Garbage Collection](https://docs.lakefs.io/howto/garbage-collection/managed-gc.html)** | | ✅ | | ||
| **[SOC2 Compliant](https://docs.lakefs.io/security/)** | | ✅ | | ||
| **[Managed Garbage Collection](../howto/garbage-collection/managed-gc.md)** | | ✅ | | ||
| **[SOC2 Compliant](../security/index.md#soc2-compliance)** | | ✅ | | ||
| **Support SLA** | | ✅ | | ||
|
||
|
||
|
||
## How lakeFS Cloud interacts with your infrastructure | ||
|
||
Treeverse hosts and manages a dedicated lakeFS instance that interfaces with data held in your object store, such as S3. | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
--- | ||
title: Deployment options | ||
description: Overview of lakeFS Enterprise deployment options | ||
--- | ||
|
||
# Deployment Options | ||
|
||
1. lakeFS Cloud | ||
2. lakeFS Enterprise | ||
Comment on lines
+8
to
+9
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. General note about our "lakeFS Enterprise" - do people understand that what we call Enterprise is on-prem? There are a many solution where the two are not the same. |
||
|
||
That's it. |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Enterprise Support | ||
description: Overview of lakeFS Enterprise Support | ||
--- | ||
|
||
# lakeFS Enterprise Support | ||
|
||
- content here. |
This file was deleted.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can remove "in lakeFS" all items in quick start are lakeFS steps