docs: migrate docs to GitHub repository #403

sergeyberezansky · 2024-11-28T14:31:47Z

Opening a PR for easy commenting on the current docs

### TL;DR Added multi-architecture support for AMD64 and ARM64 platforms in Docker builds and updated GitHub Actions workflows. ### What changed? - Added QEMU setup in GitHub Actions workflows for multi-architecture support - Included `platforms: linux/amd64,linux/arm64` in Docker build steps - Updated README to mention support for both AMD64 and ARM64 platforms - Made minor formatting improvements in workflow files ### How to test? 1. Build the Docker image for both AMD64 and ARM64 platforms 2. Verify that the image can be pulled and run on both architectures 3. Deploy the Helm chart on a Kubernetes cluster with mixed AMD64 and ARM64 nodes 4. Ensure that the CSI driver functions correctly on both architectures ### Why make this change? This change expands the compatibility of the CSI WekaFS Plugin to support ARM64 architecture, in addition to the existing AMD64 support. This allows for greater flexibility in deployment across different hardware platforms and cloud environments, potentially improving performance and cost-efficiency for users with ARM-based infrastructure.

…S and support same fs name on SCMC

…d multiple API calls

…upport it

…unt during umount

…S and support same fs name on SCMC (#383) ### TL;DR Refactored mount handling to improve container name management and mount reference counting. ### What changed? - Added container name caching to ApiClient - Introduced `EnsureLocalContainer` method to handle container name resolution - Simplified mount reference counting using a flat map structure - Added utility function to extract container names from mount points - Fixed duplicate reference count increment in NFS mounting - Added comprehensive test coverage for container name extraction - Improved logging for mount operations and debugging ### How to test? 1. Test mounting filesystems with different container configurations 2. Verify container name extraction from mount points using the new test cases 3. Check mount reference counting behavior with multiple mount/unmount operations 4. Validate logging output for mount operations 5. Test compatibility with both legacy and new mounting scenarios ### Why make this change? - Improves reliability of container name handling in multi-cluster environments - Simplifies mount reference counting logic to prevent memory leaks - Enhances debugging capabilities through better logging - Reduces code duplication and potential race conditions - Makes the codebase more maintainable and testable

Added link to the doc and reworded the intro

Updated banner

graphite-app · 2024-11-28T14:35:11Z

Graphite Automations

"Request reviewers once CI passes" took an action on this PR • (11/28/24)

1 reviewer was added to this PR based on Sergey Berezansky's automation.

sergeyberezansky

@AriAttias I created a PR on behalf of you.
Please just fix the relevant places and continue pushing to same branch

sergeyberezansky · 2024-11-28T14:32:39Z

README.md

@@ -29,9 +29,6 @@ https://github.com/weka/csi-wekafs
 - [SELinux Support & Installation Notes](selinux/README.md)
 - [Using Weka CSI Plugin with NFS transport](docs/NFS.md)

-## Additional Documentation
- [Official Weka CSI Plugin documentation](https://docs.weka.io/appendices/weka-csi-plugin)
-


Same should be done on README.md.gotmpl

I've removed the reference to the official doc.

sergeyberezansky · 2024-11-28T14:32:47Z

charts/csi-wekafsplugin/README.md


 ## Usage
 - [Deploy an Example application](https://github.com/weka/csi-wekafs/blob/master/docs/usage.md)
 - [SELinux Support & Installation Notes](https://github.com/weka/csi-wekafs/blob/master/selinux/README.md)

-## Additional Documentation
- [Official Weka CSI Plugin documentation](https://docs.weka.io/appendices/weka-csi-plugin)
-


Same should be done on README.md.gotmpl

I've already removed the reference to the official doc from the README.md.gotml.
Why does the comment appear twice?

sergeyberezansky · 2024-11-28T14:34:03Z

docs/NFS.md

+### Limitations and constraints
+
+**Warning**:
+As of version 2.5.0 and until further notice, publishing snapshot-backed volumes via NFS transport is not recommended. This is an open issue currently under investigation.


Make it a quote with prepending with >
Same way as it is done in other places

Added > for notes and warnings

sergeyberezansky · 2024-11-28T14:36:04Z

docs/NFS.md

+
+#### Mount options
+
+The WEKA CSI Plugin automatically sets mount options for NFS transport. When custom mount options are specified in the storage class, the WEKA CSI Plugin translates them into NFS alternatives. Any unknown or unsupported mount options are ignored.


Please add a comment that directly setting NFS mount options is not supported.

sergeyberezansky · 2024-11-28T14:38:05Z

docs/NFS.md

+2. **NFS failback check**:
+   * If the WEKA client is not set up, the plugin checks if NFS failback is enabled or if NFS use is forced.
+   * If NFS failback is enabled, the plugin uses NFS transport for volume provisioning and publishing.
+   * If NFS failback is disabled, the plugin does not start and logs an error message. See the section to enable NFS failback.


misses link to the installation section

Added a link to the installation with NFS section.

sergeyberezansky · 2024-11-29T05:54:01Z

migration/migrate-legacy-csi-volumes.sh

@@ -29,7 +31,7 @@ Optional parameters:
 --------------------
 --debug             Execute with debug level logging
 --csi-volumes-dir   Assume CSI volumes are stored in different directory on the filesystem. Default is "csi-volumes"
--endpoint-address  API_ADDRESS:PORT of a Weka backend server, should be used for stateless clients.
+--endpoint-address  API_ADDRESS:PORT of a WEKA backend server for stateless clients.


should be specified if host is not connected to the cluster

Added: Specify the port if the host is not connected to the cluster.

sergeyberezansky · 2024-11-29T05:56:06Z

migration/upgrade-legacy-pv.md

+
+Kubernetes does not allow modifying the StorageClass parameters; hence every volume created with the legacy-model storage class never reports its credentials.
+
+WEKA CSI Plugin **0.7.0** provides a unique configuration mode in which legacy volumes can be bound to a single secret, referring to a single WEKA cluster API connection parameters. In this configuration mode, every request to serve, such as create, delete, and expand, a legacy Persistent Volume (or Persistent Volume Claim) that originates from a Legacy Storage Class (without reference to an API secret) communicates to that cluster.


From version 0.7.0 we provide a "fallback" mode that allows to bind the "secretless" legacy volumes to a specific sevret name.
Will be removed since CSI 3.0 hence discouraged

Added to the note:
This fallback mode of version 0.7.0 is discouraged as it will be deprecated and removed starting with CSI 3.0.

sergeyberezansky · 2024-11-29T05:57:23Z

migration/upgrade-legacy-pv.md

+WEKA CSI Plugin **0.7.0** provides a unique configuration mode in which legacy volumes can be bound to a single secret, referring to a single WEKA cluster API connection parameters. In this configuration mode, every request to serve, such as create, delete, and expand, a legacy Persistent Volume (or Persistent Volume Claim) that originates from a Legacy Storage Class (without reference to an API secret) communicates to that cluster.
+
+**Note**:
+Volumes provisioned by the CSI Plugin of version **0.7.0** in the API-based communication model, but on older versions of the WEKA cluster (below version **3.13.0**), are still in legacy mode. However, because the storage class already contains the secret reference, specifying the `legacyVolumeSecretName` parameter is unnecessary, and you can safely skip to the **Migrate legacy volumes** procedure below.


is this something I wrote in origin?

You can find the original text in version 3.14 (before I came to WEKA).
https://docs.weka.io/3.14/appendix/weka-csi-plugin#upgrading-legacy-persistent-volumes-for-capacity-enforcement

sergeyberezansky · 2024-11-29T06:01:54Z

selinux/README.md

@@ -1,142 +1,159 @@
-# CSI WekaFS SELinux Support
+# Add SELinux support


This section refers only to SELinux enabled deployments different from RedHat OpenShift Container Platform (OCP)
For OCP, all necessary configurations are performed automatically

Added the above to the overview

sergeyberezansky · 2024-11-29T06:03:41Z

selinux/README.md


-The reason behind this is a lack of permissions for containers to access objects stored on Weka cluster.


have you removed this intentionally? please re-add

Re-added this line.

sergeyberezansky · 2024-12-02T12:22:04Z

docs/csi-images/k8s-multiple-clusters.png

This slide should also be changed with NFS support
Add another K8s worker node named "Branch / Remote K8s worker node" or whatever distinguishes it from the rest. Then this node does not have a Weka Client and instead uses Kernel NFS driver and connects to NFS gateway on some clusters

Or maybe instead add another slide that provides 2 nodes only connected to same / different clusters, one is NFS, another is wekafs

Removed the reference to the official doc.

Added > to warning and note

Added > before a warning

Added a link to installation with NFS

Added: Specify the port if the host is not connected to the cluster.

Added to the note: This fallback mode of version **0.7.0** is discouraged as it will be deprecated and removed starting with CSI 3.0.

Updated the intro with: - This section applies to ... - The purpose of this section ...

Added > before notes

Reworded the note about volumes provisioned in 0.7.0.

Replacing the image: k8s-multiple-clusters.png

Replaced the overview for Kubernetes Storage Integration with WEKA: WekaFS and NFS Transport Modes. Now, we need to update the procedure steps accordingly.

edited the link to the image

Removed the note about unique fs names across multiple clusters because it is irrelevant to the architecture.

Updated the section: Kubernetes Storage Integration with WEKA: WekaFS and NFS Transport Modes

We have added a prerequisite: The WEKA CSI container must run as the root user to enable the management of WEKA filesystem mounts at the Worker Node level.

New title: Deployment and upgrade workflows. So we can add this as a reference to the main README.md

I added a reference to the deployment page in the docs. Revised the line under building the binaries

Revised the opening line.

sergeyberezansky and others added 30 commits November 1, 2024 12:04

feat(CSI-300): add arm64 support

7c025c8

refactor(CSI-305): change mount Map logic for WEKAFS to align with NF…

5c7c89f

…S and support same fs name on SCMC

refactor(CSI-305): add localContainerName on NewMount

e327c44

refactor(CSI-305): cache containerName on API client object

7efb4cd

refactor(CSI-305): simplify EnsureLocalContainer for NewMount to avoi…

492ef8a

…d multiple API calls

refactor(CSI-305): do not fill in containerName if cluster does not s…

66a1a81

…upport it

refactor(CSI-305): ensure that containerName is taken from correct mo…

efd5d7d

…unt during umount

tests(CSI-305): add tests for GetMountContainerNameFromActualMountPoint

dbdd772

chore: autopublish 2024-11-07T10:25:54Z

9ea969b

Add Storage class configurations file

ac82507

Update storage-class-configurations.md

01a16d7

Update storage-class-configurations.md

c54e772

Update storage-class-configurations.md

099b662

Update storage-class-configurations.md

64ec07f

Add files via upload

a6f0097

Add image

5f6bc2a

Update storage-class-configurations.md

bdc2c43

Add files via upload

eb5fe68

Update migrate-legacy-csi-volumes.sh

3f6f795

Added link to the doc and reworded the intro

Update migrate-legacy-csi-volumes.sh

2d5f436

Updated banner

Update upgrade-legacy-pv.md: fix links

c44d6ed

Update storage-class-configurations.md: fix links

fb27131

Update storage-class-configurations.md fix linx

205daec

Update storage-class-configurations.md

b0c8165

Update README.md: removed reference to doc.weka.io

0454366

Update NFS.md: adjusted for TW clarity

07e684d

Update NFS.md: added ```

ce4c77d

Update NFS.mdL typo

e8cfe6e

graphite-app bot requested a review from tigrawap November 28, 2024 14:31

Update README.md: reworded some sentences

3977868

sergeyberezansky commented Nov 29, 2024

View reviewed changes

sergeyberezansky added the ignore-semantic-pull-request label Nov 30, 2024

sergeyberezansky commented Dec 2, 2024

View reviewed changes

sergeyberezansky force-pushed the dev branch from abc2a6b to 3becaf7 Compare December 3, 2024 10:01

AriAttias added 23 commits December 16, 2024 11:34

Update README.md.gotmpl

65f4626

Removed the reference to the official doc.

Update NFS.md

8e72f7d

Added > to warning and note

Update NFS.md

6c82443

Added > before a warning

Update NFS.md

935a53c

Added a link to installation with NFS

Update migrate-legacy-csi-volumes.sh

350572d

Added: Specify the port if the host is not connected to the cluster.

Update upgrade-legacy-pv.md

4bde915

Added to the note: This fallback mode of version **0.7.0** is discouraged as it will be deprecated and removed starting with CSI 3.0.

Update README.md

453b4df

Updated the intro with: - This section applies to ... - The purpose of this section ...

Update storage-class-configurations.md

94b55f3

Added > before notes

Update upgrade-legacy-pv.md

c4ea5fa

Reworded the note about volumes provisioned in 0.7.0.

Add CSI-k8s-wekafs-nfs

3b086b2

Replacing the image: k8s-multiple-clusters.png

Delete docs/csi-images/k8s-multiple-clusters.png

e6a0ba2

Update storage-class-configurations.md

490ff71

Replaced the overview for Kubernetes Storage Integration with WEKA: WekaFS and NFS Transport Modes. Now, we need to update the procedure steps accordingly.

Rename CSI-k8s-wekafs-nfs.png to csi-k8s-wekafs-nfs.png

65699f8

Update storage-class-configurations.md

94f36fe

edited the link to the image

Replace the image

0eefc5b

Update storage-class-configurations.md

bdc5dec

Removed the note about unique fs names across multiple clusters because it is irrelevant to the architecture.

Update storage-class-configurations.md

d683fea

Updated the section: Kubernetes Storage Integration with WEKA: WekaFS and NFS Transport Modes

Update deployment.md (per David's comment)

3d7f8d2

We have added a prerequisite: The WEKA CSI container must run as the root user to enable the management of WEKA filesystem mounts at the Worker Node level.

Update deployment.md: modified title

2f535cc

New title: Deployment and upgrade workflows. So we can add this as a reference to the main README.md

Update README.md.gotmpl

a8a09e5

I added a reference to the deployment page in the docs. Revised the line under building the binaries

Update README.md

2cd55aa

Revised the opening line.

Update README.md-fix link

448ffaa

Update README.md.gotmpl-fix link

5d26eb5

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: migrate docs to GitHub repository #403

docs: migrate docs to GitHub repository #403

sergeyberezansky commented Nov 28, 2024

graphite-app bot commented Nov 28, 2024

sergeyberezansky left a comment

sergeyberezansky Nov 28, 2024

AriAttias Dec 16, 2024

sergeyberezansky Nov 28, 2024

AriAttias Dec 16, 2024

sergeyberezansky Nov 28, 2024

AriAttias Dec 16, 2024

sergeyberezansky Nov 28, 2024

AriAttias Dec 16, 2024

sergeyberezansky Nov 28, 2024

AriAttias Dec 16, 2024

sergeyberezansky Nov 29, 2024

AriAttias Dec 16, 2024

sergeyberezansky Nov 29, 2024

AriAttias Dec 16, 2024

sergeyberezansky Nov 29, 2024

AriAttias Dec 16, 2024

sergeyberezansky Nov 29, 2024

AriAttias Dec 16, 2024

sergeyberezansky Nov 29, 2024

AriAttias Dec 16, 2024

sergeyberezansky Dec 2, 2024

sergeyberezansky Dec 2, 2024


		#### Mount options

		The WEKA CSI Plugin automatically sets mount options for NFS transport. When custom mount options are specified in the storage class, the WEKA CSI Plugin translates them into NFS alternatives. Any unknown or unsupported mount options are ignored.


		Kubernetes does not allow modifying the StorageClass parameters; hence every volume created with the legacy-model storage class never reports its credentials.

		WEKA CSI Plugin 0.7.0 provides a unique configuration mode in which legacy volumes can be bound to a single secret, referring to a single WEKA cluster API connection parameters. In this configuration mode, every request to serve, such as create, delete, and expand, a legacy Persistent Volume (or Persistent Volume Claim) that originates from a Legacy Storage Class (without reference to an API secret) communicates to that cluster.

		@@ -1,142 +1,159 @@
		# CSI WekaFS SELinux Support
		# Add SELinux support


		The reason behind this is a lack of permissions for containers to access objects stored on Weka cluster.

docs: migrate docs to GitHub repository #403

Are you sure you want to change the base?

docs: migrate docs to GitHub repository #403

Conversation

sergeyberezansky commented Nov 28, 2024

graphite-app bot commented Nov 28, 2024

Graphite Automations

sergeyberezansky left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment