-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* chore: upgrade dependencies * chore: update twitter logo * add redirect * fix url * remove plugin * add intro page * consolidate running * refactor building * finalize * refactor Co-authored-by: Lovro Mažgon <[email protected]> * refactor Co-authored-by: Lovro Mažgon <[email protected]> * add redirect * add plugin * add redirects and change default * add index pages * some more updates * hide table of contents --------- Co-authored-by: Lovro Mažgon <[email protected]>
- Loading branch information
1 parent
15c9a84
commit 50dd4a9
Showing
28 changed files
with
1,763 additions
and
859 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
{ | ||
"label": "Building Connectors", | ||
"position": 5, | ||
"collapsed": false | ||
"collapsed": true | ||
} |
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 @@ | ||
--- | ||
title: 'Building Connectors' | ||
sidebar_position: 0 | ||
--- | ||
|
||
import DocCardList from '@theme/DocCardList'; | ||
|
||
<DocCardList/> |
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 @@ | ||
--- | ||
title: 'Connectors' | ||
sidebar_position: 0 | ||
--- | ||
|
||
import DocCardList from '@theme/DocCardList'; | ||
|
||
<DocCardList/> |
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
{ | ||
"label": "Features", | ||
"position": 2 | ||
"position": 3 | ||
} |
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 @@ | ||
--- | ||
title: 'Features' | ||
sidebar_position: 0 | ||
--- | ||
|
||
import DocCardList from '@theme/DocCardList'; | ||
|
||
<DocCardList/> |
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,4 @@ | ||
{ | ||
"label": "Getting Started", | ||
"position": 1 | ||
} |
File renamed without changes.
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,11 @@ | ||
--- | ||
title: 'Getting Started with Conduit' | ||
sidebar_position: 0 | ||
sidebar_label: "Getting Started" | ||
--- | ||
|
||
import DocCardList from '@theme/DocCardList'; | ||
|
||
To help you get started, here are some of initial pages you might want to check out: | ||
|
||
<DocCardList/> |
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,160 @@ | ||
--- | ||
title: "Installing and running" | ||
sidebar_position: 0 | ||
hide_table_of_contents: true | ||
--- | ||
|
||
import Tabs from '@theme/Tabs'; | ||
import TabItem from '@theme/TabItem'; | ||
|
||
<Tabs groupId="instalation-options" queryString="option"> | ||
<TabItem value="homebrew" label="Homebrew" default> | ||
The recommended way of running Conduit on a local machine is using the latest version of Conduit available on [Homebrew](https://brew.sh/) which you can instally by running the following command: | ||
|
||
``` | ||
brew install conduit | ||
``` | ||
|
||
### Run | ||
|
||
Once installed, you can start Conduit by running: | ||
|
||
```shell | ||
conduit | ||
``` | ||
|
||
</TabItem> | ||
<TabItem value="binary" label="Using a pre-built binary"> | ||
Below we'll walk through getting Conduit installed and running on your system. | ||
|
||
### Download | ||
|
||
First, download the [latest Conduit release](https://github.com/ConduitIO/conduit/releases/latest) for your platform. | ||
|
||
For an ARM based back Mac for example we'd grab the `conduit_0.10.0_Darwin_arm64.tar.gz` archive. | ||
|
||
### unzip the archive | ||
|
||
```shell | ||
tar xzvf conduit_0.10.0_Darwin_arm64.tar.gz | ||
``` | ||
|
||
### Run | ||
|
||
In the directory in which you expanded the archive. Execute the Conduit binary: | ||
|
||
```shell | ||
./conduit | ||
``` | ||
</TabItem> | ||
|
||
<TabItem value="docker" label="Docker"> | ||
We distribute [Docker](https://docs.docker.com/) images to ease the use of Conduit in a containerized environment. To see details about how our images are built please feel free to take a look at the `Dockerfile` [here](https://github.com/ConduitIO/conduit/blob/main/Dockerfile). | ||
Conduit's Docker images are hosted on [GitHub](https://github.com/ConduitIO/conduit/pkgs/container/conduit). | ||
|
||
### Run | ||
|
||
After you install Docker, you can pull the Conduit image by running the following command: | ||
|
||
```shell | ||
docker pull conduit.docker.scarf.sh/conduitio/conduit | ||
``` | ||
Then, you can run Conduit by running: | ||
|
||
```shell | ||
docker run -it -p 8080:8080 conduit.docker.scarf.sh/conduitio/conduit | ||
``` | ||
|
||
The command aboves runs Conduit with no pipelines. To run Conduit with a custom pipeline file you can mount it as a volume into the container: | ||
```shell | ||
docker run -it -p 8080:8080 \ | ||
-v /path/to/pipeline.yaml:/app/pipelines/pipeline.yaml \ | ||
conduit.docker.scarf.sh/conduitio/conduit | ||
``` | ||
|
||
:::tip | ||
If you're using Docker, check out [Watchtower](https://containrrr.dev/watchtower/). After we push an update, Watchtower will keep your Conduit container updated by gracefully shutting down your existing container and restarting it with the same options used when initially deployed. | ||
::: | ||
|
||
</TabItem> | ||
<TabItem value="source" label="Building from source"> | ||
Before you can build Conduit from source, you need to have Go 1.21 or higher installed. The Go website has [comprehensive instructions](https://go.dev/doc/install) on how to get the language installed on your machine. Once installed, you can follow the rest of the instructions. | ||
|
||
1. Start by downloading the source code from the latest stable release on the Conduit [Releases Page](https://github.com/ConduitIO/conduit/releases/latest). Alternatively, you can run this command to automatically download the latest stable source to your current directory: | ||
|
||
```shell | ||
$ TAG=v0.10.0 curl -o conduit.tar.gz -L https://github.com/ConduitIO/conduit/archive/refs/tags/$TAG.tar.gz | ||
``` | ||
|
||
A file called `conduit.tgz` will be in your current directory. The next step is to expand the source: | ||
|
||
```shell | ||
$ tar zxvf conduit.tgz | ||
``` | ||
|
||
Then change directories to the appropriate folder. Keep in mind that the folder name might be different between releases since it's tied to the latest git sha for the commit. | ||
|
||
```shell | ||
$ cd conduit-0.10.0 | ||
``` | ||
|
||
Now build the project: | ||
|
||
```shell | ||
$ make | ||
``` | ||
|
||
If you want to build conduit without the UI, instead of running `make`, you can run the following command: | ||
|
||
```shell | ||
$ make build-server | ||
``` | ||
|
||
You will have a new binary built for your architecture and machine. All that's left is to run it! | ||
|
||
```shell | ||
./conduit | ||
``` | ||
</TabItem> | ||
</Tabs> | ||
|
||
You should now be able to interact with the Conduit UI and HTTP API on port 8080: | ||
|
||
```shell | ||
.... | ||
.::::::::::. | ||
.:::::‘‘‘‘:::::. | ||
.:::: ::::. | ||
.:::::::: ::::::::. | ||
`:::::::: ::::::::‘ | ||
`:::: ::::‘ | ||
`:::::....:::::‘ | ||
`::::::::::‘ Conduit v0.10.0 linux/amd64 | ||
‘‘‘‘ | ||
2024-02-20T21:37:45+00:00 INF All 0 tables opened in 0s component=badger.DB | ||
2024-02-20T21:37:45+00:00 INF Discard stats nextEmptySlot: 0 component=badger.DB | ||
2024-02-20T21:37:45+00:00 INF Set nextTxnTs to 0 component=badger.DB | ||
2024-02-20T21:37:45+00:00 INF builtin plugins initialized component=builtin.Registry count=6 | ||
2024-02-20T21:37:45+00:00 WRN could not read plugin directory error="open /app/connectors: no such file or directory" component=standalone.Registry | ||
2024-02-20T21:37:45+00:00 INF standalone plugins initialized component=standalone.Registry count=0 plugin_path=/app/connectors | ||
2024-02-20T21:37:45+00:00 INF processors initialized component=processor.Service count=0 | ||
2024-02-20T21:37:45+00:00 INF connectors initialized component=connector.Service count=0 | ||
2024-02-20T21:37:45+00:00 INF pipelines initialized component=pipeline.Service count=0 | ||
2024-02-20T21:37:45+00:00 INF pipeline configs provisioned component=provisioning.Service created=[] deleted=[] pipelines_path=./pipelines | ||
2024-02-20T21:37:45+00:00 INF grpc server started address=[::]:8084 | ||
2024-02-20T21:37:45+00:00 INF http server started address=[::]:8080 | ||
2024-02-20T21:37:45+00:00 INF | ||
2024-02-20T21:37:45+00:00 INF click here to navigate to Conduit UI: http://localhost:8080/ui | ||
2024-02-20T21:37:45+00:00 INF click here to navigate to explore the HTTP API: http://localhost:8080/openapi | ||
2024-02-20T21:37:45+00:00 INF | ||
``` | ||
|
||
## Next Steps | ||
|
||
Now that you have Conduit installed it's time to explore some other topics. | ||
|
||
- [Pipelines](/docs/pipeline-configuration-files/getting-started) | ||
- [Connectors](/docs/connectors/getting-started) | ||
- [Processors](/docs/processors/getting-started) | ||
|
||
![scarf pixel conduit-site-docs-running](https://static.scarf.sh/a.png?x-pxid=db6468a8-7998-463e-800f-58a619edd9b3) |
File renamed without changes.
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 was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
{ | ||
"label": "Pipeline Configuration Files", | ||
"position": 3 | ||
"position": 4 | ||
} |
8 changes: 8 additions & 0 deletions
8
docs/pipeline-configuration-files/pipeline-configuration-files.mdx
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 @@ | ||
--- | ||
title: 'Pipeline Configuration Files' | ||
sidebar_position: 0 | ||
--- | ||
|
||
import DocCardList from '@theme/DocCardList'; | ||
|
||
<DocCardList/> |
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 |
---|---|---|
@@ -1,4 +1,4 @@ | ||
{ | ||
"label": "Processors", | ||
"position": 4 | ||
"position": 5 | ||
} |
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 @@ | ||
--- | ||
title: 'Processors' | ||
sidebar_position: 0 | ||
--- | ||
|
||
import DocCardList from '@theme/DocCardList'; | ||
|
||
<DocCardList/> |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.