seq-input-gelf/README.md

Speckle Repo Management Templates

Introduction

This repository contains a Helm Chart for deploying DataLust's seq-input-gelf Docker image to a Kubernetes cluster.

If deploying seq-input-gelf alongside seq, please use DataLust's official Helm Chart. This Helm Chart allows seq-input-gelf to be deployed independently of seq.

You may wish to deploy seq-input-gelf if you are exporting logs in Graylog Extended Log Format (GELF).

You may wish to deploy seq-input-gelf independently of seq if you have a multiple Kubernetes clusters, and wish to transfer log data from a source cluster to a target cluster, running seq. Alternatively, you may have seq deployed on a non-Kubernetes environment, and wish to export logs messages from Kubernetes to that external seq instance.

Documentation

Comprehensive developer and user documentation can be found in our:

Usage

1. You will require Helm and access to a Kubernetes cluster to which you have appropriate permissions to deploy resources.

2. Clone this repository and in a shell terminal, cd in to the root directory of the cloned repository.

3. Run the following command to create a secret containing your deployment key, replacing YOURAPIKEY with an API key generated by your Seq instance:

   kubectl create secret generic seq-api-key --from-value=api-key=YOURAPIKEY --namespace seq-input-gelf
   

4. Add the helm repository for this Helm Chart

   helm repo add seq-input-gelf https://specklesystems.github.io/seq-input-gelf/stable
   

5. Update the value of seq.url in ./examples/values.yaml file to match the url of your seq instance. The default example assumes seq is hosted within the same Kubernetes cluster with a Service named seq within a namespace named seq. Please adjust this as required.

6. Run the following command to install the helm chart in your kubernetes cluster. Note that this will create a new namespace named seq-input-gelf:

   helm upgrade seq-input-gelf \
   seq-input-gelf/seq-input-gelf \
   --create-namespace \
   --namespace seq-input-gelf \
   --install \
   --values ./examples/values.yaml
   

7. Verify that the deployment has successfully rolled out:

   kubectl rollout status deployment/seq-input-gelf --namespace seq-input-gelf
   

Developing & Debugging

This doesn't make sense here, but in general, we should try to provide a small "how to" guide on local development and debugging, as it lowers the barrier to contributions.

Contributing

Please make sure you read the contribution guidelines and code of conduct for an overview of the practices we try to follow.

Prerequisites

1. Your code must pass our pre-commit checks in order to be accepted.
   1. Install pre-commit.
   2. In your shell terminal, cd to the root directory of this repository.
   3. Run pre-commit install.
   4. Review the output and adjust your contribution as necessary.

Community

This Helm Chart is maintained by Speckle. The Speckle Community hangs out on the forum, do join and introduce yourself & feel free to ask us questions!

Security

For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems.

License

Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via email.