-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide basic documentation & README (#22)
Provide basic documentation & README: - How to configure it - That we have a health endpoint
- Loading branch information
1 parent
8ccd835
commit cd321f3
Showing
6 changed files
with
71 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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](/) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/). | ||
|