From a9d54e4775f37940b0f7babae6cb032ec4d223cd Mon Sep 17 00:00:00 2001
From: Iain Sproat <68657+iainsproat@users.noreply.github.com>
Date: Wed, 8 Feb 2023 17:34:35 +0000
Subject: [PATCH] docs(bootstrap): bootstrap README, CI tooling and local dev
 environment

---
 README.md | 47 +++++++++++++++++++++++++----------------------
 1 file changed, 25 insertions(+), 22 deletions(-)

diff --git a/README.md b/README.md
index fccc8f6..ce9edf4 100644
--- a/README.md
+++ b/README.md
@@ -4,48 +4,51 @@
 
 ## Introduction
 
-This section should hold a quick intro on what this repo's about. For example:
+This repository contains a Helm Chart for deploying [DataLust's `seq-input-gelf`](https://docs.datalust.co/docs/using-gelf#enabling-gelf-in-docker) Docker image to a Kubernetes cluster.
 
-This repo holds Speckle's:
+If deploying `seq-input-gelf` alongside `seq`, please use DataLust's [official Helm Chart](https://github.com/datalust/helm.datalust.co/tree/main/charts/seq). This Helm Chart allows `seq-input-gelf` to be deployed independently of `seq`.
 
-- Default [Code of Conduct](.github/CODE_OF_CONDUCT.md),
-- Default [Contribution Guidelines](.github/CONTRIBUTING.md),
-- README template (you're reading it now),
-- Default [Issue Template](.github/ISSUE_TEMPLATE/ISSUE_TEMPLATE.md),
-- Default [Pull Request Template](.github/PULL_REQUEST_TEMPLATE/PR_TEMPLATE.md),
-- OSS License (Apache 2.0)
+You may wish to deploy `seq-input-gelf` if you are exporting logs in Graylog Extended Log Format (GELF).
 
-Either copy paste the parts that are useful in existing repos, or use this as a base when creating a new repository.
+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:
 
-#### 📚 [Speckle Docs website](https://speckle.guide/dev/)
+### Usage
 
-## This Readme Template
+1. You will require [Helm](https://helm.sh/docs/intro/install/) and access to a [Kubernetes](https://kubernetes.io/) cluster to which you have appropriate permissions to deploy resources.
+1. Clone this repository and in a shell terminal, `cd` in to the root directory of the cloned repository.
+1. Edit the file `./example/values.yaml` to include your API key for seq.
+1. 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`:
 
-Is rather straightforward. It includes several default sections and one section that requires special attention.
+    ```shell
+    helm upgrade seq-input-gelf \
+    ./charts/seq-input-gelf \
+    --create-namespace \
+    --namespace seq-input-gelf \
+    --install \
+    --values ./example/values.yaml
+    ```
 
-Default sections:
+1. Verify that the deployment has successfully [rolled out](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#deployment-status):
 
-- Badges: has several default social badges. Feel free to add more.
-- Developing & Debugging - needs filling in!
-- Community - can be left as is.
+    ```shell
+    kubectl rollout status deployment/seq-input-gelf --namespace seq-input-gelf
+    ```
 
-**License section**: If this is a pure OSS repo, like Core, remove everything after the first phrase. Otherwise, we need to plan ahead before releasing and make sure we're covered.
-
-## Developing & Debugging
+### 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
+### Contributing
 
 Please make sure you read the [contribution guidelines](.github/CONTRIBUTING.md) and [code of conduct](.github/CODE_OF_CONDUCT.md) for an overview of the practices we try to follow.
 
-## Community
+### Community
 
-The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions!
+This Helm Chart is maintained by Speckle. The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions!
 
 ## Security