- 
                Notifications
    You must be signed in to change notification settings 
- Fork 12
DOC-573: add mount PVC topic #330
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
          
     Merged
      
      
    
  
     Merged
                    Changes from all commits
      Commits
    
    
            Show all changes
          
          
            3 commits
          
        
        Select commit
          Hold shift + click to select a range
      
      
    File filter
Filter by extension
Conversations
          Failed to load comments.   
        
        
          
      Loading
        
  Jump to
        
          Jump to file
        
      
      
          Failed to load files.   
        
        
          
      Loading
        
  Diff view
Diff view
There are no files selected for viewing
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              
  
    
      This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
      Learn more about bidirectional Unicode characters
    
  
  
    
              | Original file line number | Diff line number | Diff line change | 
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| = Mount Persistent Volume Claims for Hazelcast clusters | ||
|  | ||
| You can mount one or more Persistent Volume Claims (PVCs) directly to your Hazelcast cluster. Each PVC defined in the `persistenceVolumeClaims` section will be mounted under the path `/data/<name-of-pvc>`. This approach allows you to use PVCs for any Hazelcast feature that requires persistent storage, simply by referencing the PVC by its name. | ||
|  | ||
| == How it works | ||
|  | ||
| - Define one or more PVCs in the `persistenceVolumeClaims` section of your Hazelcast custom resource (CR). | ||
| - Each PVC will be mounted at `/data/<name>`, where `<name>` is the value of the name field in your PVC configuration. | ||
| - Features that require persistent storage (such as diagnostics, persistence, or the CP Subsystem) can reference the PVC by specifying its name, using the appropriate field (e.g., `pvcName`). | ||
|  | ||
| This mechanism decouples the PVC definition from feature configuration, making it easier to manage and reuse storage across different Hazelcast features. | ||
|  | ||
| For more information, see the xref:api-ref.adoc#[API]. For a tutorial on enabling persistence, see link:https://docs.hazelcast.com/hazelcast/latest/getting-started/persistence[Persist Map Entries on Disk] | ||
|  | ||
| == Example: Configure diagnostics with a named PVC | ||
|  | ||
| Below is an example configuration that shows how to define a PVC and use it for diagnostics logging by specifying the `pvcName` field. The diagnostics logs will be stored in the PVC mounted at `/data/diagnostics-pvc-volume`. | ||
|  | ||
| [source,yaml] | ||
| ---- | ||
| apiVersion: hazelcast.com/v1alpha1 | ||
| kind: Hazelcast | ||
| metadata: | ||
| name: hazelcast | ||
| spec: | ||
| clusterSize: 3 | ||
| repository: 'docker.io/hazelcast/hazelcast-enterprise' | ||
| version: 5.6.0-SNAPSHOT | ||
| licenseKeySecretName: hazelcast-license-key | ||
| diagnostics: | ||
| outputType: STDOUT | ||
| maxRolledFileCount: 10 | ||
| maxRolledFileSize: '50M' | ||
| pvcName: diagnostics-pvc-volume | ||
| persistenceVolumeClaims: | ||
| - accessModes: [ "ReadWriteOnce" ] | ||
| requestStorage: 1Gi | ||
| storageClassName: "standard" | ||
| name: diagnostics-pvc-volume | ||
| ---- | ||
|  | ||
  Add this suggestion to a batch that can be applied as a single commit.
  This suggestion is invalid because no changes were made to the code.
  Suggestions cannot be applied while the pull request is closed.
  Suggestions cannot be applied while viewing a subset of changes.
  Only one suggestion per line can be applied in a batch.
  Add this suggestion to a batch that can be applied as a single commit.
  Applying suggestions on deleted lines is not supported.
  You must change the existing code in this line in order to create a valid suggestion.
  Outdated suggestions cannot be applied.
  This suggestion has been applied or marked resolved.
  Suggestions cannot be applied from pending reviews.
  Suggestions cannot be applied on multi-line comments.
  Suggestions cannot be applied while the pull request is queued to merge.
  Suggestion cannot be applied right now. Please check back later.
  
    
  
    
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since the first line explains this "You can mount one or more Persistent Volume Claims (PVCs) directly to your Hazelcast cluster" and in the interest of keeping the headings short, I think it's best to leave as is