Skip to content

Update plugin developer docs #227

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

Merged
merged 1 commit into from
Mar 2, 2024
Merged

Update plugin developer docs #227

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 12 additions & 3 deletions content/docs/developers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ This documentation helps to set-up a developer environment and writing plugins f

To add a `plugin` to the logging operator you need to define the plugin struct.

> Note: Place your plugin in the corresponding directory `pkg/sdk/model/filter` or `pkg/sdk/model/output`
> Note: Place your plugin in the corresponding directory `pkg/sdk/logging/model/filter` or `pkg/sdk/logging/model/output`

```go
type MyExampleOutput struct {
Expand Down Expand Up @@ -113,6 +113,13 @@ The required tag ensures that the attribute **cannot** be empty
RetryForever bool `json:"retry_forever" plugin:"required"`
```

### Add plugin to the Logging operator API

Enable your plugin for users when using the `output/flow` CRDs by adding it to the proper Logging operator API type.

- Output Plugin - [OutputSpec](https://github.com/kube-logging/logging-operator/blob/64495126b215bc852a702b47aab73df8d0515bd7/pkg/sdk/logging/api/v1beta1/output_types.go#L32)
- Filter Plugin - [Filter](https://github.com/kube-logging/logging-operator/blob/64495126b215bc852a702b47aab73df8d0515bd7/pkg/sdk/logging/api/v1beta1/flow_types.go#L64)

## Generate documentation for Plugin

The operator parse the `docstrings` for the documentation.
Expand Down Expand Up @@ -170,8 +177,10 @@ Example linking embedded sections
Buffer *Buffer `json:"buffer,omitempty"`
```

### Generate docs for your Plugin
### Generate resources for your Plugin

Run the following command to generate updated docs and CRDs for your new plugin.

```bash
make docs
make generate
```