Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 2.49 KB

development.md

File metadata and controls

65 lines (44 loc) · 2.49 KB

Lustre CSI Driver Development Guide

Prerequisite

The following software are required for local development.

Build

Run the following command to build and push the images.

make build-all-image-and-push REGISTRY=<your-container-registry> STAGINGVERSION=<staging-version>
  • REGISTRY: Optional. Specifies your container or artifact registry. If not set, the default is gcr.io/<your-project-id>. Ensure you are logged into your registry with the necessary image pull/push permissions.
  • STAGINGVERSION: Optional. Defines a build version. If not provided, a staging version will be automatically generated based on the commit hash.

Manual installation

Refer to Lustre CSI Driver Manual Installation documentation.

Test

Refer to Test documentation.

Update go modules

Follow the following steps to update go modules:

  1. Open the go.mod file in Visual Studio Code.
  2. Click "Check for upgrades" above the first require block.
  3. Hover over the module with available upgrade. Click "Quick Fix" to apply the upgrade.
  4. If you upgraded any k8s.io modules, make sure the version is also updated in the replace block. You need to do this step because lack of semantic versioning prevents go mod from finding newer releases.
  5. Run go mod tidy to ensure that the listed dependencies are really still needed.
  6. Run go mod vendor to update vendor directory.
  7. Resolve any issues that may be introduced by the new modules.

Troubleshooting

Refer to Troubleshooting documentation.