Skip to content

Commit

Permalink
Merge pull request #48 from Michaelg22/Vance-Website
Browse files Browse the repository at this point in the history
Vance website
  • Loading branch information
JieDing authored Aug 16, 2022
2 parents 45a0f14 + e9552fa commit fe27144
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 9 deletions.
Binary file added docs/images/Flowchart.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 16 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,26 @@
layout: default
title: Home
nav_order: 1
description: "The Java Connector-Development Kit (CDK) is a collection of Java packages to help you to build a new [Vance Connector][vc] in minutes."
description: "Vance is a Kubernetes-based platform that manages a variety of out-of-box connectors."
permalink: /
---

# Vance
{: .fs-9 }
Vance is a Kubernetes-based data connection platform that natively supports the CloudEvents specifications. Vance constitutes three main modules: Connectors, an Operator, and CDKs. [GitHub Repository][vance]

## Introduction
## Connectors
The Connectors module provides a large number of out-of-the-box, image-based connectors. Source-Connectors are responsible for obtaining data from the source, converting these data in different formats into a unified CloudEvent, and sending them to the target. Sink-Connectors are responsible for performing some general processing on the data in CloudEvents format (such as: Adding data to a MySQL database). Connectors enable their users to no longer focus on how to obtain or deal with data formats so they can focus on their business without any worries. [Connectors][con]

A Connector-Development Kit (CDK) aims to speed up the development of a Vance connector by offering some utilities including:
- HTTP implementations (either to handle general HTTP requests or CloudEvents)
- Config implementation to load user-specific configs
- The ability to interact with the Vance operator
- And more.
## Operator
The Operator module enables Connectors to automatically scale according to certain conditions through the HPA feature of K8s, thereby achieving the effect of serverless pay-as-you-go. For example, the Operator can increase or decrease the number of pods according to the immediate HTTP traffic(heavy/low) to maximize the utilization of resources. These custom scaling conditions may be HTTP traffic, CPU/memory load, or custom scaling conditions currently supported by KEDA. [Operator][ope]

## Getting started
## CDKs
The CDKs module enables developers to design connectors that meet the Connectors specification in the shortest time by providing class libraries and documents in various languages. [CDKs][cdks]

![alt text](images/Flowchart.jpg)


[vance]: https://github.com/linkall-labs/vance/
[con]: /connectors.md
[ope]: /operator.md
[cdks]: /cdks.md

0 comments on commit fe27144

Please sign in to comment.