Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

NOISSUE - Run Manager using Systemd Docs #42

Merged
merged 3 commits into from
Sep 16, 2024

Conversation

WashingtonKK
Copy link
Contributor

What type of PR is this?

This is an enhancement that adds docs for running manager using systemd.

What does this do?

Adds docs for running manager using systemd, a feature that was recently added.

Which issue(s) does this PR fix/relate to?

No issue

Have you included tests for your changes?

Not needed

Did you document any new/modified features?

This documents new features

Notes

docs/manager.md Outdated
Comment on lines 108 to 111
To run manager service without using makefile:

```sh
MANAGER_GRPC_URL=localhost:7001
MANAGER_LOG_LEVEL=debug \
MANAGER_QEMU_USE_SUDO=true \
MANAGER_QEMU_ENABLE_SEV=true \
MANAGER_QEMU_SEV_CBITPOS=51 \
./build/cocos-manager
```bash
sudo systemctl start cocos-manager
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

service needs to be installed first, so just remove this section


# copy binary to bin
```bash
# builds binaries, copies them to bin and installs the env variables required for manager
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add make before make install

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Make install builds the services first

docs/manager.md Outdated
sudo systemctl start cocos-manager
```

To enable [AMD SEV](https://www.amd.com/en/developer/sev.html) support, start manager after settin these environment variables in [cocos-manager.env](https://github.com/ultravioletrs/cocos/blob/main/cocos-manager.env).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fix typos

docs/manager.md Outdated
sudo systemctl start cocos-manager
```

To enable [AMD SEV](https://www.amd.com/en/developer/sev.html) support, start manager after settin these environment variables in [cocos-manager.env](https://github.com/ultravioletrs/cocos/blob/main/cocos-manager.env).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also add sev-snp

docs/manager.md Outdated

```bash
# install the service with the environment variables
make install
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

requires sudo

docs/manager.md Outdated
make install

# start the service
make run
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this one too if the env var qemu use sudo is set to true as well

docs/manager.md Outdated
Comment on lines 131 to 132
# you can also start the service with
sudo systemctl start cocos-manager
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just focus on the make commands, if something is missing we can add a make command, for example one to restart manager

docs/manager.md Outdated
@@ -130,7 +143,7 @@ go run ./test/computations/main.go <algo-path> <public-key-path> <attested-tls-b
and in the second the manager by executing (with the environment variables of choice):

```bash
./build/cocos-manager
sudo systemctl start cocos-manager
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make run

docs/manager.md Outdated
sudo systemctl status cocos-manager

# follow logs from manager
journalctl -u cocos-manager -f n20
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
journalctl -u cocos-manager -f n20
journalctl -u cocos-manager -n 20 -f

@dborovcanin dborovcanin merged commit e1e8905 into ultravioletrs:main Sep 16, 2024
1 check passed
@WashingtonKK WashingtonKK deleted the manager branch September 17, 2024 11:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants