Skip to content

Commit

Permalink
Provide basic documentation & README (#22)
Browse files Browse the repository at this point in the history
Provide basic documentation & README:
- How to configure it
- That we have a health endpoint
  • Loading branch information
tomkerkhove committed Jan 3, 2019
1 parent 8ccd835 commit cd321f3
Show file tree
Hide file tree
Showing 6 changed files with 71 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -329,3 +329,4 @@ ASALocalRun/
# MFractors (Xamarin productivity tool) working folder
.mfractor/
/src/Arcus.EventGrid.Sidecar.Api/Open-Api-Docs.xml
/docs/_site
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
# Arcus - Azure Event Grid Sidecar
[![Build status](https://dev.azure.com/codit/Arcus/_apis/build/status/Commit%20builds/CI%20-%20Arcus.EventGrid.Sidecar)](https://dev.azure.com/codit/Arcus/_build/latest?definitionId=552)
[![License](https://img.shields.io/github/license/mashape/apistatus.svg?style=flat-square)](./LICENSE)
[![Build Status](https://dev.azure.com/codit/Arcus/_apis/build/status/Commit%20builds/CI%20-%20Arcus.EventGrid.Sidecar)](https://dev.azure.com/codit/Arcus/_build/latest?definitionId=552)
[![Docker Pulls](https://img.shields.io/docker/pulls/arcusazure/azure-event-grid-sidecar.svg?style=flat-square)](https://hub.docker.com/r/arcusazure/azure-event-grid-sidecar/)
[![Docker Stars](https://img.shields.io/docker/stars/arcusazure/azure-event-grid-sidecar.svg?style=flat-square)](https://hub.docker.com/r/arcusazure/azure-event-grid-sidecar/)

Sidecar for sending events to Azure Event Grid.

![Arcus](https://raw.githubusercontent.com/arcus-azure/arcus/master/media/arcus.png)

# Installation
The image is available on [Docker Hub](https://cloud.docker.com/u/arcusazure/repository/docker/arcusazure/azure-event-grid-sidecar) and can be installed via [Docker](https://eventgrid-sidecar.arcus-azure.net/#installation).

# Documentation
All documentation can be found on [here](https://eventgrid-sidecar.arcus-azure.net/).

Expand Down
8 changes: 8 additions & 0 deletions docs/_site/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Documentation
====

All documentation for Arcus Event Grid Sidecar which are published via GitHub Pages with Jekyll.

## Running Jekyll locally

Running Jekyll locally to test your changes is super easy, learn more about it [here](https://jekyllrb.com/docs/#instructions).
12 changes: 12 additions & 0 deletions docs/config/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
layout: default
title: Configuration
---

Here is an overview of how you can configure the container.

# Runtime
The runtime is flexible and allows you to configure it to meet your needs:
- **ARCUS_HTTP_PORT** - Defines the port to serve HTTP traffic _(default 80)_

[← back](/)
20 changes: 17 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,28 @@ redirect_from:
- /index.html
---

# Installation
**Arcus Event Grid Sidecar** is a container that makes it easier to integrate with Azure Event Grid.

It's a hosted REST API that allows you to POST events to which will be forwarded to an Azure Event Grid Topic of choice.

One of its main use cases is to run it as a sidecar next to your application but it can also be used as a standalone app in your infrastructure.

![Arcus Logo](https://raw.githubusercontent.com/arcus-azure/arcus/master/media/arcus.png)

```shell
# Installation
Running Arcus Event Grid Sidecar is super easy:
```
docker run -d -p 8999:80 --name arcus arcusazure/azure-event-grid-sidecar
```

Docker image is available on [Docker Hub](https://hub.docker.com/r/arcusazure/azure-event-grid-sidecar).

# Features
No features are supported yet.
- Monitor runtime with a health endpoint ([docs](operations/health))

# Documentation
- **Configuration**
- [Runtime](config#runtime)

# License
This is licensed under The MIT License (MIT). Which means that you can use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the web application. But you always need to state that Codit is the original author of this web application.
Expand Down
26 changes: 26 additions & 0 deletions docs/operations/health.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
layout: default
title: Health
---

In order to operate the runtime we provide some tooling to automate the process.

## Health Endpoint
We expose a health endpoint that gives an indication whether or not the runtime is able to serve traffic.

You can easily query it with a simple GET:
```bash
curl -X GET "http://localhost:88/api/v1/health"
-H "accept: application/json" --include
```

If everything is ok it will return an HTTP 200, otherwise an HTTP 503.

```bash
HTTP/1.1 200 OK
Date: Thu, 03 Jan 2019 12:50:36 GMT
Content-Length: 0
```

This feature allows you to determine if the container is successfully started up or if it's still healthy. It easily integrates with [Kubernetes' liveness & readiness probes](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/).

0 comments on commit cd321f3

Please sign in to comment.