Skip to content
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.

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

docs: add just eat kongverge integration to kong hub #1

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
74 changes: 74 additions & 0 deletions app/_hub/justeat/kongverge/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
---
name: Kongverge
publisher: Just Eat

categories:
- deployment

type: integration

desc: A Desired State Configuration tool for Kong.

description: |
Kongverge is a command-line tool written in .NET Core 2.1. It is used to configure a kong server by moving its state into sync with the “desired state” given in configuration files.

Kongverge uses several ‘data transfer objects’ to read from files and write to Kong (and vice versa). For simplicity, the field names on these objects generally match what is present in Kong:

* KongConfiguration
* KongRoute
* KongService
* KongPlugin

These objects also handle matching - i.e. reconciling the state described by files with the state in Kong, and performing actions in Kong as needed to make them the same. The possible cases for these objects are:

* Unchanged; The object in Kong is identical to the object in config, so no action is required.
* Changed; the object in Kong is matched with an object in config, but not all of the properties are the same. Action is required to update the object in place.
* New; the object needs to be added to Kong.
* Deleted; the object needs to be removed from Kong.

support_url: https://github.com/justeat/kongverge/issues

source_url: https://github.com/justeat/kongverge

license_type: Apache-2.0

license_url: https://github.com/justeat/kongverge/blob/master/LICENSE

kong_version_compatibility:
community_edition:
compatible:
- 0.14.x
incompatible:
- 0.13.x
- 0.12.x
- 0.11.x
- 0.10.x
- 0.9.x
- 0.8.x
- 0.7.x
- 0.6.x
- 0.5.x
- 0.4.x
- 0.3.x
- 0.2.x
enterprise_edition:
compatible:
incompatible:
- 0.33-x
- 0.32-x
- 0.31-x
- 0.30-x

###############################################################################
# END YAML DATA
# Beneath the next --- use Markdown (redcarpet flavor) and HTML formatting only.
#
# The remainder of this file is for free-form description, instruction, and
# reference matter.
###############################################################################
# BEGIN MARKDOWN CONTENT
---

## Documentation

A tutorial, installation steps and further information can be found [here](https://github.com/justeat/kongverge).