Skip to content
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

[Doc] Add NFS-on-Longhorn documentation #1183

Closed
bgulla opened this issue Apr 13, 2020 · 9 comments
Closed

[Doc] Add NFS-on-Longhorn documentation #1183

bgulla opened this issue Apr 13, 2020 · 9 comments
Assignees
Labels
area/install-uninstall-upgrade Install, Uninstall or Upgrade related highlight Important feature/issue to highlight kind/doc Doc request kind/feature Feature request, new feature priority/1 Highly recommended to fix in this release (managed by PO) require/auto-e2e-test Require adding/updating auto e2e test cases if they can be automated require/manual-test-plan Require adding/updating manual test cases if they can't be automated
Milestone

Comments

@bgulla
Copy link

bgulla commented Apr 13, 2020

As a user of Longhorn, I would like to know how I can help support the applications I deploy that require RWX. It has been brought to my attention that running an NFS layer atop longhorn will facilitate that type of use case. Can we add supporting documentation to help walk through users in the setup of this approach?

@yasker yasker assigned yasker and unassigned yasker Apr 13, 2020
@yasker yasker added area/install-uninstall-upgrade Install, Uninstall or Upgrade related kind/doc Doc request kind/feature Feature request, new feature and removed kind/feature Feature request, new feature labels Apr 13, 2020
@yasker yasker added this to the v1.0.0 milestone Apr 13, 2020
@yasker
Copy link
Member

yasker commented Apr 27, 2020

Depends on the result of #1105

@yasker yasker self-assigned this Apr 30, 2020
@yasker yasker added the priority/1 Highly recommended to fix in this release (managed by PO) label Apr 30, 2020
@yasker yasker assigned joshimoo and unassigned yasker May 25, 2020
@yasker
Copy link
Member

yasker commented May 29, 2020

We need a test plan for NFS. Ideally, we should test it end to end for the workload cases.

@yasker yasker added require/auto-e2e-test Require adding/updating auto e2e test cases if they can be automated require/manual-test-plan Require adding/updating manual test cases if they can't be automated labels May 29, 2020
@yasker yasker modified the milestones: v1.0.0, v1.0.1 May 29, 2020
@joshimoo
Copy link
Contributor

joshimoo commented Jun 2, 2020

Pre-merged Checklist

  • Does the PR include the explanation for the fix or the feature?

  • Is the backend code merged?
    The PR is at Add example deployment of nfs on top of a longhorn for RWX volumes #1425

  • Is the reproduce steps/test steps documented?

  • If the fix introduces the code for backward compatibility Has an separate issue been filed with the label release/obsolete-compatibility?
    The compatibility issue is filed at

  • If labeled: area/ui Has the UI issue filed or ready to be merged?
    The UI issue/PR is at

  • if labeled: require/doc Has the necessary document PR submitted or merged?
    The Doc issue/PR is at Add documentation for RWX workloads website#151

  • If labeled: require/automation-e2e Has the end-to-end test plan been merged? Have QAs agreed on the automation test case?
    Tracking issue for e2e rwx integration tests Add e2e integration tests for RWX volumes  #1606

  • if labeled: require/automation-engine Has the engine integration test been merged?
    The engine automation PR is at

  • if labeled: require/manual-test-plan Has the manual test plan been documented?
    The updated manual test plan is at

@yasker
Copy link
Member

yasker commented Jun 24, 2020

One additional thing to consider is when after we implement #1470 , it should be easy for the user to upgrade. My biggest concern is if the user can use the same StorageClass name longhorn-nfs in the later version and seamlessly migrate to the new solution.

@yasker yasker added highlight Important feature/issue to highlight kind/feature Feature request, new feature and removed highlight Important feature/issue to highlight labels Jun 29, 2020
@khushboo-rancher khushboo-rancher self-assigned this Jul 7, 2020
@khushboo-rancher
Copy link
Contributor

Validation - Passed

Followed the docs https://staging.longhorn.io/docs/1.0.0/advanced-resources/rwx-workloads/ example workloads are coming up healthy properly.
The links of yamls are broken currently but will be fixed with https://github.com/longhorn/website/pull/159/files

RWX functionality is working fine.
Test cases executed from https://rancher.atlassian.net/wiki/spaces/LON/pages/515376490/RWX+Volumes

@jaredkipe
Copy link

This is great! Except that I've now spent a lot of time extracting the state out of some apps into s3/minio (+redis for some things) and you suddenly give me an easier way.

FWIW, I did try NFS provisioner on-top of a longhorn volume, and I had some inconsistent results. e.g. I STILL have a stuck pod on a production cluster that cannot be removed for some reason and it was part of that experiment.

I will try the longhorn built in when ready.

@joshimoo
Copy link
Contributor

joshimoo commented Jul 14, 2020

FWIW, I did try NFS provisioner on-top of a longhorn volume, and I had some inconsistent results. e.g. I STILL have a stuck pod on a production cluster that cannot be removed for some reason and it was part of that experiment.

@jaredkipe Was this using the longhorn provided nfs-provisioner deployments that will be released with 1.0.1?

@jaredkipe
Copy link

@joshimoo No, I mean like a year ago on one cluster and 6 months ago on another.

@joshimoo
Copy link
Contributor

@khushboo-rancher added a tracking issue for the e2e integration tests #1606 can you close this issue?

yasker added a commit to yasker/longhorn that referenced this issue Jul 21, 2020
i## Highlights:
1. [Make Longhorn Helm Chart directly available through Helm repo](longhorn#1043). Now the users can use `helm repo add longhorn https://charts.longhorn.io` to find and install Longhorn easily through Helm command line.
1. [NFS on Longhorn for RWX Access Mode (experimental)](longhorn#1183). We've provided a way to add Longhorn backed NFS provisioner to the cluster, so now user can use `longhorn-nfs` StorageClass to provision RWX volumes. Note: currently NFS provisioner is not highly available. If the node NFS provisioner running is down, the workload using RWX volume might be interrupted for a couple of minutes before restoring the service. Check [here](https://staging.longhorn.io/docs/1.0.0/advanced-resources/rwx-workloads/) for details.
1. Improved Air Gap Environment Support. Check [here](https://staging.longhorn.io/docs/1.0.0/advanced-resources/deploy/airgap/) for updated document for air gap installation.
    1. [Remove the air gap image name length limitation](longhorn#1323).
    1. [Change the default image pull policy from `Always` to `IfNotPresent`](longhorn#1491)
    1. [Aggregate the necessary Docker images](longhorn#1419)
    1. [HTTP/HTTPS_PROXY support for S3 backupstore](longhorn#1540)
1. [Support PriorityClass for Longhorn deployment](longhorn#1487). Check [here](https://staging.longhorn.io/docs/1.0.0/advanced-resources/deploy/priority-class/) for details.

Live upgrade from v1.0.0 to v1.0.1 is supported.

Signed-off-by: Sheng Yang <sheng.yang@rancher.com>
yasker added a commit that referenced this issue Jul 21, 2020
i## Highlights:
1. [Make Longhorn Helm Chart directly available through Helm repo](#1043). Now the users can use `helm repo add longhorn https://charts.longhorn.io` to find and install Longhorn easily through Helm command line.
1. [NFS on Longhorn for RWX Access Mode (experimental)](#1183). We've provided a way to add Longhorn backed NFS provisioner to the cluster, so now user can use `longhorn-nfs` StorageClass to provision RWX volumes. Note: currently NFS provisioner is not highly available. If the node NFS provisioner running is down, the workload using RWX volume might be interrupted for a couple of minutes before restoring the service. Check [here](https://staging.longhorn.io/docs/1.0.0/advanced-resources/rwx-workloads/) for details.
1. Improved Air Gap Environment Support. Check [here](https://staging.longhorn.io/docs/1.0.0/advanced-resources/deploy/airgap/) for updated document for air gap installation.
    1. [Remove the air gap image name length limitation](#1323).
    1. [Change the default image pull policy from `Always` to `IfNotPresent`](#1491)
    1. [Aggregate the necessary Docker images](#1419)
    1. [HTTP/HTTPS_PROXY support for S3 backupstore](#1540)
1. [Support PriorityClass for Longhorn deployment](#1487). Check [here](https://staging.longhorn.io/docs/1.0.0/advanced-resources/deploy/priority-class/) for details.

Live upgrade from v1.0.0 to v1.0.1 is supported.

Signed-off-by: Sheng Yang <sheng.yang@rancher.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/install-uninstall-upgrade Install, Uninstall or Upgrade related highlight Important feature/issue to highlight kind/doc Doc request kind/feature Feature request, new feature priority/1 Highly recommended to fix in this release (managed by PO) require/auto-e2e-test Require adding/updating auto e2e test cases if they can be automated require/manual-test-plan Require adding/updating manual test cases if they can't be automated
Projects
Status: Closed
Development

No branches or pull requests

5 participants