Skip to content

Commit 981c3a4

Browse files
authored
Merge pull request #127 from NearNodeFlash/release-v0.0.8
Release v0.0.8
2 parents 1ed933c + b18714a commit 981c3a4

2 files changed

Lines changed: 35 additions & 7 deletions

File tree

docs/guides/compute-daemons/readme.md

Lines changed: 30 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ categories: setup
77

88
Rabbit software requires two daemons be installed and run on each compute node. Each daemon shares similar build, package, and installation processes described below.
99

10-
- The [***Client Mount***](https://github.com/DataWorkflowServices/dws/tree/master/mount-daemon) daemon, `clientmount`, provides the support for mounting Rabbit hosted file systems on compute nodes.
10+
- The [***Client Mount***](https://github.com/NearNodeFlash/nnf-sos/tree/master/mount-daemon) daemon, `clientmount`, provides the support for mounting Rabbit hosted file systems on compute nodes.
1111
- The [***Data Movement***](https://github.com/NearNodeFlash/nnf-dm/tree/master/daemons/compute) daemon, `nnf-dm`, supports creating, monitoring, and managing data movement (copy-offload) operations
1212

1313
## Building from source
@@ -30,8 +30,8 @@ NNF software defines a Kubernetes Service Account for granting communication pri
3030

3131
| Compute Daemon | Service Account | Namespace |
3232
| -------------- | --------------- | --------- |
33-
| Client Mount | dws-controller-manager | dws-system |
34-
| Data Movement | nnf-dm-controller-manager | nnf-dm-system |
33+
| Client Mount | nnf-clientmount | nnf-system |
34+
| Data Movement | nnf-dm-daemon | nnf-dm-system |
3535

3636
```bash
3737
#!/bin/bash
@@ -61,7 +61,7 @@ The command line arguments can be provided to the service definition or as an ov
6161
| `--nnf-node-name=[RABBIT-NODE-NAME]` | `nnf-dm` daemon only. Name of the rabbit node connected to this compute node as described in the System Configuration. If not provided, the `--node-name` value is used to find the associated Rabbit node in the System Configuration. |
6262
| `--sys-config=[NAME]` | `nnf-dm` daemon only. The System Configuration resource's name. Defaults to `default` |
6363

64-
For example:
64+
An example unit file for nnf-dm:
6565

6666
```conf title="cat /etc/systemd/system/nnf-dm.service"
6767
[Unit]
@@ -75,14 +75,38 @@ ExecStart=/usr/bin/nnf-dm \
7575
--kubernetes-service-port=7777 \
7676
--service-token-file=/path/to/service.token \
7777
--service-cert-file=/path/to/service.cert \
78-
--node-name=this-compute-node \
79-
--nnf-node-name=my-rabbit-node
78+
--kubernetes-qps=50 \
79+
--kubernetes-burst=100
8080
Restart=on-failure
8181
8282
[Install]
8383
WantedBy=multi-user.target
8484
```
8585

86+
An example unit file is for clientmountd:
87+
88+
```conf title="cat /etc/systemd/system/clientmountd.service"
89+
[Unit]
90+
Description=Near-Node Flash (NNF) Clientmountd Service
91+
92+
[Service]
93+
PIDFile=/var/run/clientmountd.pid
94+
ExecStartPre=/bin/rm -f /var/run/clientmountd.pid
95+
ExecStart=/usr/bin/clientmountd \
96+
--kubernetes-service-host=127.0.0.1 \
97+
--kubernetes-service-port=7777 \
98+
--service-token-file=/path/to/service.token \
99+
--service-cert-file=/path/to/service.cert
100+
Restart=on-failure
101+
Environment=GOGC=off
102+
Environment=GOMEMLIMIT=20MiB
103+
Environment=GOMAXPROCS=5
104+
Environment=HTTP2_PING_TIMEOUT_SECONDS=60
105+
106+
[Install]
107+
WantedBy=multi-user.target
108+
```
109+
86110
#### nnf-dm Specific Configuration
87111

88112
nnf-dm has some additional configuration options that can be used to tweak the kubernetes client:

docs/repo-guides/release-nnf-sw/readme.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,8 @@ Request, **you must use a Merge Commit.**
125125
gh release create --generate-notes --verify-tag -p v0.0.3 -t "Release v0.0.3"
126126
```
127127
128+
**Note** Do not do this `gh release create` in the nnf-deploy repo. That repo will create a release automatically when a new tag is pushed.
129+
128130
9. GOTO Step 1 and repeat this process for each remaining component.
129131
130132
## Release `nnf-deploy`
@@ -188,7 +190,9 @@ that everything is current on `master` for `nnf-deploy`.
188190
11. Verify that `git status` is happy with `nnf-deploy` and then finalize the merge
189191
from master by with a `git commit`.
190192

191-
12. Follow steps 6-8 from the previous section to finalize the release of `nnf-deploy`.
193+
12. Follow steps 6-7 from the previous section to finalize the release of `nnf-deploy`.
194+
195+
**Note** In step 7, the push of the tag will cause nnf-deploy's `handle_release_tag` workflow to automatically create the release.
192196
193197
**The software is now released!**
194198

0 commit comments

Comments
 (0)