Skip to content

Commit 8e90f4a

Browse files
authored
Rename NnfStorageProfile placeholder to template (#152)
Signed-off-by: Dean Roehrich <dean.roehrich@hpe.com>
1 parent 816cef4 commit 8e90f4a

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

docs/guides/storage-profiles/readme.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ $ kubectl patch nnfstorageprofile durable -n nnf-system --type merge -p '{"data"
4747

4848
# Creating The Initial Default Profile
4949

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.
50+
Create the initial default profile from scratch or by using the [NnfStorageProfile/template](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.
5151

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:
52+
To use the `template` resource 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:
5353

5454
```shell
55-
kubectl get nnfstorageprofile -n nnf-system placeholder -o json > profile.yaml
55+
kubectl get nnfstorageprofile -n nnf-system template -o yaml > profile.yaml
5656
```
5757

5858
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:
@@ -79,17 +79,17 @@ kubectl get nnfstorageprofile -A
7979
The output will appear similar to the following:
8080

8181
```shell
82-
NAMESPACE NAME DEFAULT AGE
83-
nnf-system default true 9s
84-
nnf-system placeholder false 11s
82+
NAMESPACE NAME DEFAULT AGE
83+
nnf-system default true 9s
84+
nnf-system template false 11s
8585
```
8686

8787
The administrator should edit the `default` profile to record any cluster-specific settings.
8888
Maintain a copy of this resource YAML in a safe place so it isn't lost across upgrades.
8989

9090
## Keeping The Default Profile Updated
9191

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.
92+
An upgrade of nnf-sos may include updates to the `template` profile. It may be necessary to manually copy these updates into the `default` profile.
9393

9494
# Profile Parameters
9595

0 commit comments

Comments
 (0)