-
Notifications
You must be signed in to change notification settings - Fork 13
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
[CN-1152]: add localConfig to persistence #171
Merged
Merged
Changes from all commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
4982502
add localConfig to persistence
kutluhanmetin cb2805c
Update docs/modules/ROOT/pages/backup-restore.adoc
kutluhanmetin 2768bf2
Update docs/modules/ROOT/pages/backup-restore.adoc
kutluhanmetin 4aec03d
Update docs/modules/ROOT/pages/backup-restore.adoc
kutluhanmetin c971d9f
remove unnecessary
kutluhanmetin cfaf24f
remove unnecessary
kutluhanmetin 42d63b9
fix
kutluhanmetin 29e7229
fix
kutluhanmetin 484a2ab
hot-restart -> persistence
kutluhanmetin 6988726
improve docs
kutluhanmetin c018055
extend docs
kutluhanmetin 4e6c4c5
Update docs/modules/ROOT/pages/backup-restore.adoc
kutluhanmetin 097678b
Update docs/modules/ROOT/pages/backup-restore.adoc
kutluhanmetin 6bb2de3
Update docs/modules/ROOT/pages/backup-restore.adoc
kutluhanmetin ac412b8
Update docs/modules/ROOT/pages/backup-restore.adoc
kutluhanmetin 148e257
Update docs/modules/ROOT/pages/backup-restore.adoc
kutluhanmetin f5be65c
Update docs/modules/ROOT/pages/backup-restore.adoc
kutluhanmetin 7d5b290
fix PR comment
kutluhanmetin 32bb2dd
improve docs
kutluhanmetin f3d9354
remove unnecessary space
kutluhanmetin 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
19 changes: 19 additions & 0 deletions
19
docs/modules/ROOT/examples/hazelcast-persistence-restore-local.yaml
This file contains 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,19 @@ | ||
apiVersion: hazelcast.com/v1alpha1 | ||
kind: Hazelcast | ||
metadata: | ||
name: hazelcast <1> | ||
spec: | ||
clusterSize: 3 | ||
repository: 'docker.io/hazelcast/hazelcast-enterprise' | ||
licenseKeySecretName: hazelcast-license-key | ||
customConfigCmName: mapCustomConfig <2> | ||
persistence: | ||
pvc: | ||
accessModes: ["ReadWriteOnce"] | ||
requestStorage: 20Gi | ||
restore: | ||
localConfig: | ||
pvcNamePrefix: "hot-restart-persistence" <3> | ||
baseDir: "base" <4> | ||
backupDir: "backup" <5> | ||
backupFolder: "backup-1709045128548" <6> |
This file contains 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,16 @@ | ||
apiVersion: v1 | ||
kind: Pod | ||
metadata: | ||
name: list-content-pod | ||
spec: | ||
containers: | ||
- name: list-content-container | ||
image: busybox | ||
command: ["/bin/sh", "-c", "tree /data/persistence"] <1> | ||
volumeMounts: | ||
- name: pv-storage | ||
mountPath: /data/persistence <2> | ||
volumes: | ||
- name: pv-storage | ||
persistentVolumeClaim: | ||
claimName: hot-restart-persistence-hazelcast-0 <3> |
This file contains 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
Oops, something went wrong.
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.
We should have titles or at least listing approach to emphasize the two different restore scenario when we have local backup. I don't know if it makes sense for you but I suggest something like this.
While thinking about their difference, I bring another idea. How about creating new page just for the newly added restore support? Since backup and restore features are expected as one of the main features which will be used always by the all customers who are using operator. However, newly supported restore is not actually a feature which will be used continuously. Instead, it's kinda migration solution for older operator versions and helm chart users. Also in the future we may decide to support fully custom backups. Are we going to put it also in this page? I don't think so, it'll be a migration solution as well so I suggest to separate new restore option from the existing one. Sorry for late feedback, I just got into this idea.
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.
Such a nice a feedback Cagri, let's talk with the team and decide together. I am not sure %100 but it might be a good idea to make it a part of migration documents.
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.
A better idea would be to put the documentation about localConfig in here, and reference it from migration documentations.
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.
Can we provide examples of both methods, and some guidance on when to use Operator and when to use Helm?
All information on restore ought to be in a single place; preferably with headings that clearly indicate what the section covers. For example, in this section it could be Use Restore for Migration; in the migration section it could be Migrate using a Backup.
The required configuration is best with the content it will be used with.
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.
I committed more changes to improve the docs: 32bb2dd. I didn't mention about the helm and migration words explicitly, because in the feature we will have specific guides for those scenarios like hazelcast/hz-docs#1052. We will refer to this document from them.