COSI-21: Add/improve docs and update versions to 1.0.0 #106

anurag4DSB · 2025-01-15T14:54:27Z

Add/improve docs and update versions to 1.0.0

codecov · 2025-01-15T15:05:46Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.47%. Comparing base (d2c62e4) to head (ea33ec9).
Report is 2 commits behind head on main.

Additional details and impacted files

Components	Coverage Δ
🏠 Main Package	`∅ <ø> (∅)`
🚗 Driver Package	`92.22% <ø> (ø)`
📡 gRPC Factory Package	`82.35% <ø> (ø)`
🔐 IAM Client Package	`98.17% <ø> (ø)`
🌐 S3 Client Package	`94.33% <ø> (ø)`
🔧 Util Package	`100.00% <ø> (ø)`
🔖 Constants Package	`∅ <ø> (∅)`

@@           Coverage Diff           @@
##             main     #106   +/-   ##
=======================================
  Coverage   92.47%   92.47%           
=======================================
  Files          11       11           
  Lines         771      771           
=======================================
  Hits          713      713           
  Misses         49       49           
  Partials        9        9

docs/driver-params.md

docs/Usage.md

BourgoisMickael · 2025-01-16T10:26:22Z

docs/Usage.md

+   cat <<EOF | kubectl apply -f -
+   apiVersion: objectstorage.k8s.io/v1alpha1
+   kind: BucketClaim
+   metadata:
+     name: my-brownfield-bucketclaim
+     namespace: container-object-storage-system
+   spec:
+     bucketClassName: brownfield-bucket-class
+     existingBucketName: "<EXISTING_BUCKET_NAME>"
+     protocols:
+       - S3
+   EOF


Remove indent

Suggested change

cat <<EOF | kubectl apply -f -

apiVersion: objectstorage.k8s.io/v1alpha1

kind: BucketClaim

metadata:

name: my-brownfield-bucketclaim

namespace: container-object-storage-system

spec:

bucketClassName: brownfield-bucket-class

existingBucketName: "<EXISTING_BUCKET_NAME>"

protocols:

- S3

EOF

cat <<EOF | kubectl apply -f -

apiVersion: objectstorage.k8s.io/v1alpha1

kind: BucketClaim

metadata:

name: my-brownfield-bucketclaim

namespace: container-object-storage-system

spec:

bucketClassName: brownfield-bucket-class

existingBucketName: "<EXISTING_BUCKET_NAME>"

protocols:

- S3

EOF

I would like to keep the indent, as Kubernetes throws parsing errors and rejects improperly formatted YAML.

BourgoisMickael · 2025-01-16T10:27:16Z

docs/Usage.md

+   cat <<EOF | kubectl apply -f -
+   apiVersion: objectstorage.k8s.io/v1alpha1
+   kind: Bucket
+   metadata:
+     name: "<EXISTING_BUCKET_NAME>"
+     namespace: container-object-storage-system
+   spec:
+     bucketClaim: {}
+     driverName: cosi.scality.com
+     bucketClassName: brownfield-bucketclass
+     driverName: cosi.scality.com
+     deletionPolicy: Retain
+     existingBucketID: "<EXISTING_BUCKET_NAME>"
+     parameters:
+       objectStorageSecretName: s3-secret-for-cosi
+       objectStorageSecretNamespace: default
+     protocols:
+       - S3
+   EOF


remove indent on all those code blocks

for easy copy paste

I would like to keep the indent, as Kubernetes throws parsing errors and rejects improperly formatted YAML.

README.md

docs/Usage.md

BourgoisMickael

Same comments across the files:

Few broken links with docs and cosi-example
indent in bash code block
syntax for > [!NOTE] highlight

davidtencer

@anurag4DSB great documentation. I made some minor comments to make it a bit clearer.

README.md

docs/installation/install-helm.md

docs/Usage.md

- Adds README.md and usage docs - Updates version to 1.0.0 as default

anurag4DSB force-pushed the docs/COSI-21-add-readme-and-usage-docs branch from f00112c to 054008a Compare January 15, 2025 15:34

anurag4DSB marked this pull request as ready for review January 15, 2025 15:34