From 357f02b8418c05ca83194315844c4693f3229fda Mon Sep 17 00:00:00 2001 From: Ben Date: Mon, 25 Nov 2024 23:45:19 +0100 Subject: [PATCH 1/2] Add new docs to `README.md` Signed-off-by: Ben --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 1037719df..f6c5439da 100644 --- a/README.md +++ b/README.md @@ -201,6 +201,10 @@ Once a custom resource is installed, users can create, update and access its obj - [BackingStore](doc/backing-store-crd.md) - Storage resources. These storage targets are used to store deduplicated, compressed and encrypted chunks of data. - [NamespaceStore](doc/namespace-store-crd.md) - Data resources. These storage targets are used to store and read plain data. - [BucketClass](doc/bucket-class-crd.md) - Policies applied to a class of buckets, defines bucket policies relating to data placement. + - [Bucket Types](doc/bucket-types.md) - Overview of data and namespace buckets, and supported services + - [Bucket Replication](doc/bucket-replication.md) - Overview of bucket replication rules in NooBaa, including log-based optimizations, inner workings, and example rules + - [S3 API Compatibility](doc/s3-compatibility.md) - Overview of S3 API compatibility in NooBaa + - [AWS API Compatibility](doc/AWS_API_Compatibility.md) - Overview of AWS API calls support in NooBaa - [Account](doc/noobaa-account-crd.md) - We use the account to receive new credentials set for accessing different noobaa services. - Bucket Claim: - [OBC Provisioner](doc/obc-provisioner.md) - OBC (Object Bucket Claim) is currently the main CR to provision buckets, however it is being deprecated in favor of COSI. From ae9bcf368adb7251778017d78abbf875cae5ccfc Mon Sep 17 00:00:00 2001 From: Ben Date: Tue, 26 Nov 2024 13:55:13 +0100 Subject: [PATCH 2/2] Address comment Signed-off-by: Ben --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f6c5439da..68844990c 100644 --- a/README.md +++ b/README.md @@ -194,7 +194,9 @@ INFO[0000] operator-image: noobaa/noobaa-operator:5.18.0 You can find documentation related to noobaa operator and noobaa components in kubernetes in [doc](doc) directory. For example: - [NooBaa](doc/about-noobaa.md) - Basic terminology and links to videos. -- Customer Resources Definitions ([CRDs](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#adding-custom-resources)): +- [S3 API Compatibility](doc/s3-compatibility.md) - Overview of S3 API compatibility in NooBaa +- [AWS API Compatibility](doc/AWS_API_Compatibility.md) - Overview of AWS API calls support in NooBaa +- Custom Resources Definitions ([CRDs](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#adding-custom-resources)): A custom resource is an extension of the Kubernetes API that is not necessarily available in a default Kubernetes installation. CRDs allow users to create new types of resources without adding another API server. Once a custom resource is installed, users can create, update and access its objects using [`kubectl`](https://kubernetes.io/docs/reference/kubectl/), just as they do for built-in resources. - [NooBaaSystem](doc/noobaa-crd.md) - The basic CRD to deploy a NooBaa system. Represents a single installation of NooBaa that includes a set of sub-resources (backing-stores, bucket-classes, and buckets). @@ -203,8 +205,6 @@ Once a custom resource is installed, users can create, update and access its obj - [BucketClass](doc/bucket-class-crd.md) - Policies applied to a class of buckets, defines bucket policies relating to data placement. - [Bucket Types](doc/bucket-types.md) - Overview of data and namespace buckets, and supported services - [Bucket Replication](doc/bucket-replication.md) - Overview of bucket replication rules in NooBaa, including log-based optimizations, inner workings, and example rules - - [S3 API Compatibility](doc/s3-compatibility.md) - Overview of S3 API compatibility in NooBaa - - [AWS API Compatibility](doc/AWS_API_Compatibility.md) - Overview of AWS API calls support in NooBaa - [Account](doc/noobaa-account-crd.md) - We use the account to receive new credentials set for accessing different noobaa services. - Bucket Claim: - [OBC Provisioner](doc/obc-provisioner.md) - OBC (Object Bucket Claim) is currently the main CR to provision buckets, however it is being deprecated in favor of COSI.