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.

Sign up for GitHub

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

V1.0.0 #132

Merged
merged 16 commits into from
Oct 22, 2024
Merged

V1.0.0 #132

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
ace35dc
Add connection configuration documentation (#131)
omerosaienni Sep 18, 2024
0d54281
add .gitignore
johnsmyth Sep 18, 2024
a8eedab
add connection_import docs, update sidebar for connection, connnectio…
johnsmyth Sep 18, 2024
ddbfede
add deprecation warnings for credentials
johnsmyth Sep 18, 2024
e1bfd37
change references, examples from "credential" to "connection". Updat…
johnsmyth Sep 19, 2024
0b7b532
update build/mod-variables for new connection, notifier types and enums
johnsmyth Sep 19, 2024
b10b153
update flowpipe hcl variable, param reference for new connection, no…
johnsmyth Sep 19, 2024
35696d1
update example in flowpipe-hcl/variable for new capabilities-- connec…
johnsmyth Sep 20, 2024
db5d05a
added exit codes to cli docs
johnsmyth Oct 18, 2024
8ce0a1f
add new db connection types, update docs for mod database args (WIP)
johnsmyth Oct 18, 2024
8a251af
updates for connection docs for duckdb, postgres, sqlite, steampipe
johnsmyth Oct 21, 2024
c5878dd
add new connections to sidebar
johnsmyth Oct 21, 2024
2dd3a35
updates for connection docs for duckdb, postgres, sqlite, steampipe
johnsmyth Oct 21, 2024
af7c845
updates for connection docs for duckdb, postgres, sqlite, steampipe
johnsmyth Oct 21, 2024
ffa5c5d
change references to version 0.10.0 -> 1.0.0
johnsmyth Oct 21, 2024
e04d241
add mysql connection docs, update docs for other db connections
johnsmyth Oct 21, 2024
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
Prev Previous commit
Next Next commit
add deprecation warnings for credentials
  • Loading branch information
@johnsmyth
johnsmyth committed Sep 18, 2024
commit ddbfede6299afebee454c9c37954a3009fc1ca69
3 changes: 3 additions & 0 deletions docs/reference/config-files/credential/abuseipdb.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ sidebar_label: abuseipdb

# abuseipdb

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `abuseipdb` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [abuseipdb connection](/docs/reference/config-files/connection/abuseipdb) instead.***


The `abuseipdb` credential can be used to access AbuseIPDB resources.

```hcl
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/config-files/credential/alicloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ sidebar_label: alicloud

# alicloud

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `alicloud` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [alicloud connection](/docs/reference/config-files/connection/alicloud) instead.***


The `alicloud` credential can be used to access Alibaba Cloud resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/aws.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: aws

# aws

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `aws` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [aws connection](/docs/reference/config-files/connection/aws) instead.***

The `aws` credential can be used to access Amazon Web Services resources.

```hcl
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/config-files/credential/azure.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ sidebar_label: azure

# azure

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `azure` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [azure connection](/docs/reference/config-files/connection/azure) instead.***


The `azure` credential can be used to access Azure resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/bitbucket.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: bitbucket

# bitbucket

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `bitbucket` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [bitbucket connection](/docs/reference/config-files/connection/bitbucket) instead.***

The `bitbucket` credential can be used to access Bitbucket resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/clickup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: clickup

# clickup

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `clickup` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [clickup connection](/docs/reference/config-files/connection/clickup) instead.***

The `clickup` credential can be used to access ClickUp resources.

```hcl
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/config-files/credential/datadog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ sidebar_label: datadog

# datadog

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `datadog` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [datadog connection](/docs/reference/config-files/connection/datadog) instead.***


The `datadog` credential can be used to access Datadog resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/discord.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: discord

# discord

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `discord` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [discord connection](/docs/reference/config-files/connection/discord) instead.***

The `discord` credential can be used to access Discord resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/freshdesk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: freshdesk

# freshdesk

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `freshdesk` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [freshdesk connection](/docs/reference/config-files/connection/freshdesk) instead.***

The `freshdesk` credential can be used to access Freshdesk resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/gcp.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: gcp

# gcp

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `gcp` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [gcp connection](/docs/reference/config-files/connection/gcp) instead.***

The `gcp` credential can be used to access Google Cloud Platform resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/github.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: github

# github

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `github` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [github connection](/docs/reference/config-files/connection/github) instead.***

The `github` credential can be used to access GitHub resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/gitlab.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: gitlab

# gitlab

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `gitlab` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [gitlab connection](/docs/reference/config-files/connection/gitlab) instead.***

The `gitlab` credential can be used to access GitLab resources.

```hcl
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/config-files/credential/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ sidebar_label: credential

# Credential

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `credential` resource is deprecated and will be removed in a future version of Flowpipe. Use [connection](/docs/reference/config-files/connection) instead.***


Flowpipe **Credentials** provide a mechanism for defining and sharing secrets in your Flowpipe environment.

```hcl
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/config-files/credential/ip2locationio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ sidebar_label: ip2locationio

# ip2locationio


> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `ip2locationio` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [ip2locationio connection](/docs/reference/config-files/connection/ip2locationio) instead.***


The `ip2locationio` credential can be used to access Ip2Location.io resources.

```hcl
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/config-files/credential/ipstack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ sidebar_label: ipstack

# ipstack

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `ipstack` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [ipstack connection](/docs/reference/config-files/connection/ipstack) instead.***


The `ipstack` credential can be used to access IpStack resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/jira.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: jira

# jira

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `jira` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [jira connection](/docs/reference/config-files/connection/jira) instead.***

The `jira` credential can be used to access Jira resources.

```hcl
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/config-files/credential/jumpcloud.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ sidebar_label: jumpcloud

# jumpcloud


> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `jumpcloud` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [jumpcloud connection](/docs/reference/config-files/connection/jumpcloud) instead.***

The `jumpcloud` credential can be used to access JumpCloud resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/mastodon.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: mastodon

# mastodon

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `mastodon` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [mastodon connection](/docs/reference/config-files/connection/mastodon) instead.***

The `mastodon` credential can be used to access Mastodon resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/okta.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: okta

# okta

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `okta` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [okta connection](/docs/reference/config-files/connection/okta) instead.***

The `okta` credential can be used to access Okta resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/openai.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: openai

# openai

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `openai` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [openai connection](/docs/reference/config-files/connection/openai) instead.***

The `openai` credential can be used to access OpenAI resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/opsgenie.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: opsgenie

# opsgenie

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `opsgenie` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [opsgenie connection](/docs/reference/config-files/connection/opsgenie) instead.***

The `opsgenie` credential can be used to access OpsGenie resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/pagerduty.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: pagerduty

# pagerduty

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `pagerduty` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [pagerduty connection](/docs/reference/config-files/connection/pagerduty) instead.***

The `pagerduty` credential can be used to access PagerDuty resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/pipes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: pipes

# pipes

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `pipes` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [pipes connection](/docs/reference/config-files/connection/pipes) instead.***

The `pipes` credential can be used to access [Turbot Pipes](https://pipes.turbot.com/) resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/sendgrid.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: sendgrid

# sendgrid

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `sendgrid` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [sendgrid connection](/docs/reference/config-files/connection/sendgrid) instead.***

The `sendgrid` credential can be used to access SendGrid resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/servicenow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: servicenow

# servicenow

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `servicenow` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [servicenow connection](/docs/reference/config-files/connection/servicenow) instead.***

The `servicenow` credential can be used to access ServiceNow resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/slack.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: slack

# slack

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `slack` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [slack connection](/docs/reference/config-files/connection/slack) instead.***

The `slack` credential can be used to access Slack resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/teams.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: teams

# teams

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `teams` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [teams connection](/docs/reference/config-files/connection/teams) instead.***

The `teams` credential can be used to access Microsoft Teams resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/trello.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: trello

# trello

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `trello` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [trello connection](/docs/reference/config-files/connection/trello) instead.***

The `trello` credential can be used to access Trello resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/turbot_guardrails.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: guardrails

# guardrails

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `guardrails` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [guardrails connection](/docs/reference/config-files/connection/guardrails) instead.***

The `guardrails` credential can be used to access [Turbot Guardrails](https://turbot.com/guardrails) resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/uptimerobot.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: uptimerobot

# uptimerobot

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `uptimerobot` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [uptimerobot connection](/docs/reference/config-files/connection/uptimerobot) instead.***

The `uptimerobot` credential can be used to access UptimeRobot resources.

```hcl
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/config-files/credential/urlscan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ sidebar_label: urlscan

# urlscan

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `urlscan` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [urlscan connection](/docs/reference/config-files/connection/urlscan) instead.***


The `urlscan` credential can be used to access URLScan resources.

```hcl
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/config-files/credential/vault.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ sidebar_label: vault

# vault

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `vault` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [vault connection](/docs/reference/config-files/connection/vault) instead.***


The `vault` credential can be used to access Vault resources.

```hcl
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/config-files/credential/virustotal.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ sidebar_label: virustotal

# virustotal


> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `virustotal` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [virustotal connection](/docs/reference/config-files/connection/virustotal) instead.***

The `virustotal` credential can be used to access VirusTotal resources.

```hcl
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/config-files/credential/zendesk.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ sidebar_label: zendesk

# zendesk

> ***As of Flowpipe 0.10.0, `credential` has been renamed to `connection`. The `zendesk` credential resource is deprecated and will be removed in a future version of Flowpipe. Use the [zendesk connection](/docs/reference/config-files/connection/zendesk) instead.***

The `zendesk` credential can be used to access Zendesk resources.

```hcl
Expand Down
3 changes: 3 additions & 0 deletions docs/reference/config-files/credential_import/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ sidebar_label: credential_import
# Credential Import


> ***As of Flowpipe 0.10.0, `credential_import` has been renamed to `connection_import`. The `credential_import` resource is deprecated and will be removed in a future version of Flowpipe. Use [connection_import](/docs/reference/config-files/connection_import) instead.***


The `credential_import` resource allows you to bulk import credentials from other systems & formats. `credential_import` is a top-level block defined in config files (`*.fpc`) like `credential` and `workspace`.

```hcl
Expand Down
4 changes: 4 additions & 0 deletions docs/reference/config-files/credential_import/steampipe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ sidebar_label: steampipe

# steampipe


> ***As of Flowpipe 0.10.0, `credential_import` has been renamed to `connection_import`. The `credential_import` resource is deprecated and will be removed in a future version of Flowpipe. Use [connection_import](/docs/reference/config-files/connection_import) instead.***


The `steampipe` credential import resource allows you to bulk import credentials from Steampipe connections. This allows you to import the plugin credentials from your Steampipe installation into Flowpipe.

```hcl
Expand Down
Loading