Skip to content

Commit

Permalink
Merge branch 'main' into steve/redpanda-connect
Browse files Browse the repository at this point in the history
  • Loading branch information
goodroot authored Oct 8, 2024
2 parents d5123fc + 6858c83 commit 307f55d
Show file tree
Hide file tree
Showing 43 changed files with 359 additions and 186 deletions.
2 changes: 1 addition & 1 deletion concept/root-directory-structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@ Log files look like this:
## `public` directory
Contains the web files for the Web Console:
Contains the web files for the [Web Console](/docs/web-console/):
```filestructure
└── public
Expand Down
44 changes: 22 additions & 22 deletions configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ description: Server configuration keys reference documentation.
---

import { ConfigTable } from "@theme/ConfigTable"
import sharedWorkerConfig from "./configuration-utils/_shared-worker.config.json"
import httpConfig from "./configuration-utils/_http.config.json"
import cairoConfig from "./configuration-utils/_cairo.config.json"
import parallelSqlConfig from "./configuration-utils/_parallel-sql.config.json"
import walConfig from "./configuration-utils/_wal.config.json"
import csvImportConfig from "./configuration-utils/_csv-import.config.json"
import postgresConfig from "./configuration-utils/_postgres.config.json"
import tcpConfig from "./configuration-utils/_tcp.config.json"
import udpConfig from "./configuration-utils/_udp.config.json"
import replicationConfig from "./configuration-utils/_replication.config.json"
import oidcConfig from "./configuration-utils/_oidc.config.json"
import sharedWorkerConfig from "./configuration-utils/\_shared-worker.config.json"
import httpConfig from "./configuration-utils/\_http.config.json"
import cairoConfig from "./configuration-utils/\_cairo.config.json"
import parallelSqlConfig from "./configuration-utils/\_parallel-sql.config.json"
import walConfig from "./configuration-utils/\_wal.config.json"
import csvImportConfig from "./configuration-utils/\_csv-import.config.json"
import postgresConfig from "./configuration-utils/\_postgres.config.json"
import tcpConfig from "./configuration-utils/\_tcp.config.json"
import udpConfig from "./configuration-utils/\_udp.config.json"
import replicationConfig from "./configuration-utils/\_replication.config.json"
import oidcConfig from "./configuration-utils/\_oidc.config.json"

This page describes methods for configuring QuestDB server settings.

Expand Down Expand Up @@ -115,7 +115,7 @@ configuration) every other subsystem.

### HTTP server

This section describes configuration settings for the Web Console and the REST
This section describes configuration settings for the [Web Console](/docs/web-console/) and the REST
API available by default on port `9000`. For details on the use of this
component, refer to the [web console documentation](/docs/web-console/) page.

Expand Down Expand Up @@ -143,16 +143,16 @@ CSV files.
Settings for `COPY`:

<ConfigTable
rows={csvImportConfig}
pick={[
"cairo.sql.copy.root",
"cairo.sql.copy.work.root",
"cairo.iouring.enabled",
"cairo.sql.copy.buffer.size",
"cairo.sql.copy.log.retention.days",
"cairo.sql.copy.max.index.chunk.size",
"cairo.sql.copy.queue.capacity",
]}
rows={csvImportConfig}
pick={[
"cairo.sql.copy.root",
"cairo.sql.copy.work.root",
"cairo.iouring.enabled",
"cairo.sql.copy.buffer.size",
"cairo.sql.copy.log.retention.days",
"cairo.sql.copy.max.index.chunk.size",
"cairo.sql.copy.queue.capacity",
]}
/>

#### CSV import configuration for Docker
Expand Down
14 changes: 7 additions & 7 deletions deployment/aws-official-ami.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ software vendors that runs on AWS. This guide describes how to launch QuestDB
via the AWS Marketplace using the official listing. This document also describes
usage instructions after you have launched the instance, including hints for
authentication, the available interfaces, and tips for accessing the REST API
and web console.
and [Web Console](/docs/web-console/).

## Prerequisites

Expand Down Expand Up @@ -51,7 +51,7 @@ For details on the server properties and using this file, see the

The default ports used by QuestDB interfaces are as follows:

- Web console &amp; REST API is available on port `9000`
- [Web Console](/docs/web-console/) &amp; REST API is available on port `9000`
- PostgreSQL wire protocol available on `8812`
- InfluxDB line protocol `9009` (TCP and UDP)
- Health monitoring &amp; Prometheus `/metrics` `9003`
Expand Down Expand Up @@ -143,14 +143,14 @@ systemctl stop questdb.service
- Download and copy over the new binary

<InterpolateReleaseData
renderText={(release) => (
<CodeBlock className="language-shell">
{`wget https://github.com/questdb/questdb/releases/download/${release.name}/questdb-${release.name}-no-jre-bin.tar.gz \\
renderText={(release) => (
<CodeBlock className="language-shell">
{`wget https://github.com/questdb/questdb/releases/download/${release.name}/questdb-${release.name}-no-jre-bin.tar.gz \\
tar xzvf questdb-${release.name}-no-jre-bin.tar.gz
cp questdb-${release.name}-no-jre-bin/questdb.jar /usr/local/bin/questdb.jar
cp questdb-${release.name}-no-jre-bin/questdb.jar /usr/local/bin/questdb-${release.name}.jar`}
</CodeBlock>
)}
</CodeBlock>
)}
/>

- Restart the service again:
Expand Down
4 changes: 2 additions & 2 deletions deployment/capacity-planning.md
Original file line number Diff line number Diff line change
Expand Up @@ -358,9 +358,9 @@ If you are running the QuestDB using `systemd`, you will also need to set the `L

If you have followed the [setup guide](https://questdb.io/docs/deployment/systemd/), then the file should be called `questdb.service` and be located at `~/.config/systemd/user/questdb.service`.

Add this property to the `[Service]` section, setting it to at least `1048576`, or higher if you have set higher OS-wide limits.
Add this property to the `[Service]` section, setting it to at least `1048576`, or higher if you have set higher OS-wide limits.

Then restart the service. If you have configured these settings correctly, any warnings in the web console should now be cleared.
Then restart the service. If you have configured these settings correctly, any warnings in the [Web Console](/docs/web-console/) should now be cleared.

#### Setting system-wide open file limit on MacOS:

Expand Down
7 changes: 3 additions & 4 deletions deployment/digitalocean.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,15 @@
---
title: Launch QuestDB on DigitalOcean
sidebar_label: DigitalOcean Droplet
description:
This document describes how to launch DigitalOcean droplet with QuestDB
description: This document describes how to launch DigitalOcean droplet with QuestDB
---

DigitalOcean is a platform with software listings from independent vendors that
run on cloud resources. This guide describes how to launch QuestDB via the
DigitalOcean marketplace using the official listing. This document also
describes usage instructions after you have launched the instance, including
hints for authentication, the available interfaces, and tips for accessing the
REST API and web console.
REST API and [Web Console](/docs/web-console/).

## Prerequisites

Expand Down Expand Up @@ -75,7 +74,7 @@ For details on the server properties and using this file, see the

The default ports used by QuestDB interfaces are as follows:

- Web console &amp; REST API is available on port `9000`
- [Web Console](/docs/web-console/) &amp; REST API is available on port `9000`
- PostgreSQL wire protocol available on `8812`
- InfluxDB line protocol `9009` (TCP and UDP)
- Health monitoring &amp; Prometheus `/metrics` `9003`
Expand Down
54 changes: 27 additions & 27 deletions deployment/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ Once Docker is installed, you will need to pull QuestDB's image from
This can be done with a single command using:

<InterpolateReleaseData
renderText={(release) => (
<CodeBlock className="language-shell">
{`docker run \\
renderText={(release) => (
<CodeBlock className="language-shell">
{`docker run \\
-p 9000:9000 -p 9009:9009 -p 8812:8812 -p 9003:9003 \\
questdb/questdb:${release.name}`}
</CodeBlock>
)}
</CodeBlock>
)}
/>

This command starts a Docker container from `questdb/questdb` image. In
Expand Down Expand Up @@ -79,11 +79,11 @@ By default, `questdb/questdb` points to the latest QuestDB version available on
Docker. However, it is recommended to define the version used.

<InterpolateReleaseData
renderText={(release) => (
<CodeBlock className="language-shell">
{`questdb/questdb:${release.name}`}
</CodeBlock>
)}
renderText={(release) => (
<CodeBlock className="language-shell">
{`questdb/questdb:${release.name}`}
</CodeBlock>
)}
/>

## Environment variables
Expand Down Expand Up @@ -177,16 +177,16 @@ following example demonstrated how to mount the current directory to a QuestDB
container using the `-v` flag in a Docker `run` command:

<InterpolateReleaseData
renderText={(release) => (
<CodeBlock className="language-shell" title={"Mounting a volume"}>
{`docker run -p 9000:9000 \\
renderText={(release) => (
<CodeBlock className="language-shell" title={"Mounting a volume"}>
{`docker run -p 9000:9000 \\
-p 9009:9009 \\
-p 8812:8812 \\
-p 9003:9003 \\
-v "$(pwd):/var/lib/questdb" \\
questdb/questdb:${release.name}`}
</CodeBlock>
)}
</CodeBlock>
)}
/>

The current directory will then have data persisted to disk for convenient
Expand All @@ -211,14 +211,14 @@ http.bind.to=0.0.0.0:4000

Running the container with the `-v` flag allows for mounting the current
directory to QuestDB's `conf` directory in the container. With the server
configuration above, HTTP ports for the web console and REST API will be
configuration above, HTTP ports for the [Web Console](/docs/web-console/) and REST API will be
available on [localhost:4000](http://localhost:4000):

```bash
docker run -v "$(pwd):/var/lib/questdb/conf" -p 4000:4000 questdb/questdb
```

:::note
:::note

If you wish to use ZFS for your QuestDB deployment, with Docker, then you will need to enable ZFS on the host volume that Docker uses.

Expand Down Expand Up @@ -261,21 +261,21 @@ docker rm dd363939f261
3. Download the latest QuestDB image:

<InterpolateReleaseData
renderText={(release) => (
<CodeBlock className="language-shell">
{`docker pull questdb/questdb:${release.name}`}
</CodeBlock>
)}
renderText={(release) => (
<CodeBlock className="language-shell">
{`docker pull questdb/questdb:${release.name}`}
</CodeBlock>
)}
/>

4. Start a new container with the new version and the same volume mounted:

<InterpolateReleaseData
renderText={(release) => (
<CodeBlock className="language-shell">
{`docker run -p 8812:8812 -p 9000:9000 -v "$(pwd):/var/lib/questdb" questdb/questdb:${release.name}`}
</CodeBlock>
)}
renderText={(release) => (
<CodeBlock className="language-shell">
{`docker run -p 8812:8812 -p 9000:9000 -v "$(pwd):/var/lib/questdb" questdb/questdb:${release.name}`}
</CodeBlock>
)}
/>

### Writing logs to disk
Expand Down
4 changes: 2 additions & 2 deletions deployment/google-cloud-platform.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ tag** `questdb` will now have this firewall rule applied.

The ports we have opened are:

- `9000` for the REST API and Web Console
- `9000` for the REST API and [Web Console](/docs/web-console/)
- `8812` for the PostgreSQL wire protocol

## Verify the deployment
Expand All @@ -145,7 +145,7 @@ To verify that the QuestDB deployment is operating as expected:
1. Copy the **External IP** of the instance
2. Navigate to `http://<external_ip>:9000` in a browser

The Web Console should now be visible:
The [Web Console](/docs/web-console/) should now be visible:

<Screenshot
alt="The QuestDB Web Console running on a VM instance on Google Cloud Platform"
Expand Down
2 changes: 1 addition & 1 deletion deployment/systemd.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ systemctl --user status questdb.service
Your QuestDB instance should now be accessible at localhost, with services
available at the following default ports:

- Web console &amp; REST API is available on port `9000`
- [Web Console](/docs/web-console/) &amp; REST API is available on port `9000`
- PostgreSQL wire protocol available on `8812`
- InfluxDB line protocol `9009` (TCP and UDP)
- Health monitoring &amp; Prometheus `/metrics` `9003`
Expand Down
14 changes: 7 additions & 7 deletions guides/active-directory-pingfederate.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,15 @@ First thing first, let's pick a name for the client!
width={750}
/>

The QuestDB Web Console is a SPA (Single Page App).
The QuestDB [Web Console](/docs/web-console/) is a SPA (Single Page App).

As a result, it cannot store safely a client secret.

Instead it can use PKCE (Proof Key for Code Exchange) to secure the flow.

As shown above, leave the client authentication disabled.

We also have to white list the URL of the Web Console as a redirection URL:
We also have to white list the URL of the [Web Console](/docs/web-console/) as a redirection URL:

<Screenshot
alt="PingFederate image, redirection URL"
Expand All @@ -43,7 +43,7 @@ We also have to white list the URL of the Web Console as a redirection URL:
/>

We can instruct PingFederate to automatically authorize the scopes requested by
the Web Console.
the [Web Console](/docs/web-console/).

The user will not be presented the extra window asking for consent after
authentication:
Expand All @@ -55,7 +55,7 @@ authentication:
width={500}
/>

The Web Console uses the
The [Web Console](/docs/web-console/) uses the
[Authorization Code Flow](/docs/operations/openid-connect-oidc-integration/#authentication-and-authorization-flow),
and refreshes tokens automatically.

Expand Down Expand Up @@ -96,7 +96,7 @@ QuestDB does not require any special setup regarding the access token.
We recommend that you do not to use shorter tokens than the default 28
characters.

As the QuestDB Web Console refreshes the token automatically, there is no need
As the QuestDB [Web Console](/docs/web-console/) refreshes the token automatically, there is no need
for long-lived tokens:

<Screenshot
Expand Down Expand Up @@ -142,7 +142,7 @@ Next, ensure the `ROLL REFRESH TOKEN VALUES` option is selected:
jumbo={true}
/>

It is also important to whitelist the Web Console's URL on the CORS list:
It is also important to whitelist the [Web Console](/docs/web-console/)'s URL on the CORS list:

<Screenshot
alt="PingFederate, authorization server ui"
Expand Down Expand Up @@ -327,7 +327,7 @@ QuestDB requires a mapping, as laid out in the
[OIDC operations document](/docs/operations/openid-connect-oidc-integration/#mapping-user-permissions).

If a given user has the HTTP permission, they will be able to now login via the
Web Console.
[Web Console](/docs/web-console/).

Head to [http://localhost:9000](http://localhost:9000) and login, to test.

Expand Down
2 changes: 1 addition & 1 deletion guides/create-database.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ specific types.

For most applications, you will import your data using methods like the InfluxDB
Line Protocol, CSV imports, or integration with third-party tools such as
Telegraf, Kafka, or Prometheus. If your interest lies in data ingestion rather
Telegraf, [Kafka](/docs/third-party-tools/kafka/overview/), or Prometheus. If your interest lies in data ingestion rather
than generation, refer to our [ingestion overview](/docs/ingestion-overview/).
Alternatively, the [QuestDB demo instance](https://demo.questdb.io) offers a
practical way to explore data creation and manipulation without setting up your
Expand Down
Loading

0 comments on commit 307f55d

Please sign in to comment.