Skip to content

Commit

Permalink
Merge pull request #127 from NearNodeFlash/release-v0.0.8
Browse files Browse the repository at this point in the history
Release v0.0.8
  • Loading branch information
bdevcich authored Feb 9, 2024
2 parents 1ed933c + b18714a commit 981c3a4
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 7 deletions.
36 changes: 30 additions & 6 deletions docs/guides/compute-daemons/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ categories: setup

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

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

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

| Compute Daemon | Service Account | Namespace |
| -------------- | --------------- | --------- |
| Client Mount | dws-controller-manager | dws-system |
| Data Movement | nnf-dm-controller-manager | nnf-dm-system |
| Client Mount | nnf-clientmount | nnf-system |
| Data Movement | nnf-dm-daemon | nnf-dm-system |

```bash
#!/bin/bash
Expand Down Expand Up @@ -61,7 +61,7 @@ The command line arguments can be provided to the service definition or as an ov
| `--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. |
| `--sys-config=[NAME]` | `nnf-dm` daemon only. The System Configuration resource's name. Defaults to `default` |

For example:
An example unit file for nnf-dm:

```conf title="cat /etc/systemd/system/nnf-dm.service"
[Unit]
Expand All @@ -75,14 +75,38 @@ ExecStart=/usr/bin/nnf-dm \
--kubernetes-service-port=7777 \
--service-token-file=/path/to/service.token \
--service-cert-file=/path/to/service.cert \
--node-name=this-compute-node \
--nnf-node-name=my-rabbit-node
--kubernetes-qps=50 \
--kubernetes-burst=100
Restart=on-failure
[Install]
WantedBy=multi-user.target
```

An example unit file is for clientmountd:

```conf title="cat /etc/systemd/system/clientmountd.service"
[Unit]
Description=Near-Node Flash (NNF) Clientmountd Service
[Service]
PIDFile=/var/run/clientmountd.pid
ExecStartPre=/bin/rm -f /var/run/clientmountd.pid
ExecStart=/usr/bin/clientmountd \
--kubernetes-service-host=127.0.0.1 \
--kubernetes-service-port=7777 \
--service-token-file=/path/to/service.token \
--service-cert-file=/path/to/service.cert
Restart=on-failure
Environment=GOGC=off
Environment=GOMEMLIMIT=20MiB
Environment=GOMAXPROCS=5
Environment=HTTP2_PING_TIMEOUT_SECONDS=60
[Install]
WantedBy=multi-user.target
```

#### nnf-dm Specific Configuration

nnf-dm has some additional configuration options that can be used to tweak the kubernetes client:
Expand Down
6 changes: 5 additions & 1 deletion docs/repo-guides/release-nnf-sw/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ Request, **you must use a Merge Commit.**
gh release create --generate-notes --verify-tag -p v0.0.3 -t "Release v0.0.3"
```
**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.
9. GOTO Step 1 and repeat this process for each remaining component.
## Release `nnf-deploy`
Expand Down Expand Up @@ -188,7 +190,9 @@ that everything is current on `master` for `nnf-deploy`.
11. Verify that `git status` is happy with `nnf-deploy` and then finalize the merge
from master by with a `git commit`.

12. Follow steps 6-8 from the previous section to finalize the release of `nnf-deploy`.
12. Follow steps 6-7 from the previous section to finalize the release of `nnf-deploy`.

**Note** In step 7, the push of the tag will cause nnf-deploy's `handle_release_tag` workflow to automatically create the release.
**The software is now released!**
Expand Down

0 comments on commit 981c3a4

Please sign in to comment.