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.

Sign up for GitHub

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

Jump to bottom

docs: add info about openssl, pkg-config deps #339

Merged
merged 4 commits into from
Jun 14, 2021
Merged

docs: add info about openssl, pkg-config deps #339

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0bb2d60
docs: add info about openssl, pkg-config deps
shantanoo-desai Jun 9, 2021
1880c06
docs: point to `cargo-generate` installation section
shantanoo-desai Jun 9, 2021
8d7f1ea
docs: refactor docs for clarity
shantanoo-desai Jun 9, 2021
afdabfb
refactor(docs): remove redundant sentence
shantanoo-desai Jun 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/discovery-handler-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,9 +146,12 @@ deleted Configuration.

## Creating a Discovery Handler in Rust using a template
Rust Discovery Handler development can be kick-started using Akri's [Discovery Handler template](https://github.com/kate-goldenring/akri-discovery-handler-template) and
[`cargo-generate`](https://github.com/cargo-generate/cargo-generate). Specify the name of your project.
```sh
cargo install cargo-generate
[`cargo-generate`](https://github.com/cargo-generate/cargo-generate).

Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate#installation) and
use the tool to pull down Akri's template, specifying the name of the project with the `--name` parameter.

```sh
cargo generate --git https://github.com/kate-goldenring/akri-discovery-handler-template.git --name akri-discovery-handler
```
This template abstracts away the work of registering with the Agent and creating the Discovery Handler service. All you
Expand Down
11 changes: 6 additions & 5 deletions docs/extensibility.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@ the Agent, which hosts the `Registration` service defined in the gRPC interface.

## New DiscoveryHandler implementation
### Use `cargo generate` to clone the Discovery Handler template
Pull down the [Discovery Handler template](https://github.com/kate-goldenring/akri-discovery-handler-template) using
[`cargo-generate`](https://github.com/cargo-generate/cargo-generate).
```sh
cargo install cargo-generate

Install [`cargo-generate`](https://github.com/cargo-generate/cargo-generate#installation) and
use the tool to pull down Akri's template, specifying the name of the project with the `--name` parameter.

```sh
cargo generate --git https://github.com/kate-goldenring/akri-discovery-handler-template.git --name akri-http-discovery-handler
```
### Specify the DiscoveryHandler name and whether discovered devices are sharable
Expand Down Expand Up @@ -672,4 +673,4 @@ used in our installation command.
We can watch as the broker pods get deployed:
```bash
watch kubectl get pods -o wide
```
```