Skip to content

Commit e4dc599

Browse files
authored
Describe new default NnfStorageProfile (#140)
Describe the process for creating and maintaining the default NnfStorageProfile. This profile uses NnfStorageProfile/placeholder as a template. Signed-off-by: Dean Roehrich <dean.roehrich@hpe.com>
1 parent 88ba071 commit e4dc599

1 file changed

Lines changed: 46 additions & 0 deletions

File tree

docs/guides/storage-profiles/readme.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,52 @@ To clear the default flag on a profile
4545
$ kubectl patch nnfstorageprofile durable -n nnf-system --type merge -p '{"data":{"default":false}}'
4646
```
4747

48+
# Creating The Initial Default Profile
49+
50+
Create the initial default profile from scratch or by using the [NnfStorageProfile/placeholder](https://github.com/NearNodeFlash/nnf-sos/blob/master/config/examples/nnf_v1alpha1_nnfstorageprofile.yaml) resource as a template. If `nnf-deploy` was used to install nnf-sos then the default profile described below will have been created automatically.
51+
52+
To use the `placeholder` resource as a template, begin by obtaining a copy of it either from the nnf-sos repo or from a live system. To get it from a live system use the following command:
53+
54+
```shell
55+
kubectl get nnfstorageprofile -n nnf-system placeholder -o json > profile.yaml
56+
```
57+
58+
Edit the `profile.yaml` file to trim the metadata section to contain only a name and namespace. The namespace must be left as nnf-system, but the name should be set to signify that this is the new default profile. In this example we will name it `default`. The metadata section will look like the following, and will contain no other fields:
59+
60+
```yaml
61+
metadata:
62+
name: default
63+
namespace: nnf-system
64+
```
65+
66+
Mark this new profile as the default profile by setting `default: true` in the data section of the resource:
67+
68+
```yaml
69+
data:
70+
default: true
71+
```
72+
73+
Apply this resource to the system and verify that it is the only one marked as the default resource:
74+
75+
```shell
76+
kubectl get nnfstorageprofile -A
77+
```
78+
79+
The output will appear similar to the following:
80+
81+
```shell
82+
NAMESPACE NAME DEFAULT AGE
83+
nnf-system default true 9s
84+
nnf-system placeholder false 11s
85+
```
86+
87+
The administrator should edit the `default` profile to record any cluster-specific settings.
88+
Maintain a copy of this resource YAML in a safe place so it isn't lost across upgrades.
89+
90+
## Keeping The Default Profile Updated
91+
92+
An upgrade of nnf-sos may include updates to the `placeholder` profile. It may be necessary to manually copy these updates into the `default` profile.
93+
4894
# Profile Parameters
4995

5096
## XFS

0 commit comments

Comments
 (0)