Skip to content

Commit

Permalink
Rename NnfStorageProfile placeholder to template
Browse files Browse the repository at this point in the history
Signed-off-by: Dean Roehrich <[email protected]>
  • Loading branch information
roehrich-hpe committed Apr 24, 2024
1 parent 816cef4 commit c7984ee
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions docs/guides/storage-profiles/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ $ kubectl patch nnfstorageprofile durable -n nnf-system --type merge -p '{"data"

# Creating The Initial Default Profile

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.
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.

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:
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:

```shell
kubectl get nnfstorageprofile -n nnf-system placeholder -o json > profile.yaml
kubectl get nnfstorageprofile -n nnf-system template -o yaml > profile.yaml
```

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

```shell
NAMESPACE NAME DEFAULT AGE
nnf-system default true 9s
nnf-system placeholder false 11s
NAMESPACE NAME DEFAULT AGE
nnf-system default true 9s
nnf-system template false 11s
```

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

## Keeping The Default Profile Updated

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.
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.

# Profile Parameters

Expand Down

0 comments on commit c7984ee

Please sign in to comment.