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

Add doc for STEAMPIPE_OTEL_INSECURE env var #175

Merged
merged 3 commits into from
Feb 12, 2024
Merged
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
2 changes: 1 addition & 1 deletion docs/mods/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ You can install a mod by cloning the repository:
git clone https://github.com/turbot/steampipe-mod-aws-compliance.git
```

Unlike plugins which are installed to the `~/.steampipe` directory, mods are installed into (and loaded from) the current working directory. Alternatively, you may specify a path with the `--workspace--chdir` argument:
Unlike plugins which are installed to the `~/.steampipe` directory, mods are installed into (and loaded from) the current working directory. Alternatively, you may specify a path with the `--mod-location` argument:

```bash
steampipe query --mod-location steampipe-mod-aws-compliance
Expand Down
2 changes: 1 addition & 1 deletion docs/query/batch-query.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ Creating your own named queries is simple. First, you need to create a mod for
mkdir my-queries
```

By default, Steampipe looks for mods in the current directory, though you can specify a different directory with the `--workspace-chdir` argument. Lets change to that directory and initialize the mod:
By default, Steampipe looks for mods in the current directory, though you can specify a different directory with the `-mod-location` argument. Lets change to that directory and initialize the mod:

```bash
cd my-queries
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/cli/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar_label: steampipe dashboard
# steampipe dashboard
Run the Steampipe Dashboard server.

The Dashboard loads the `mod` in the current working directory or the `--workspace-chdir` and listens for changes to dashboards defined in the `mod`.
The Dashboard loads the `mod` in the current working directory or the `--mod-location` and listens for changes to dashboards defined in the `mod`.

## Usage
Run [Steampipe Dashboard](/docs/dashboard/overview) interactively:
Expand Down
7 changes: 4 additions & 3 deletions docs/reference/env-vars/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Note that plugins may also support environment variables, but these are plugin-s
| [PIPES_HOST](reference/env-vars/pipes_host) | `pipes.turbot.com` | Set the Turbot Pipes host, for connecting to Turbot Pipes workspace.
| [PIPES_TOKEN](reference/env-vars/pipes_token) | | Set the Turbot Pipes authentication token for connecting to Turbot Pipes workspace.
| [STEAMPIPE_CACHE](reference/env-vars/steampipe_cache)| `true` | Enable/disable caching.
| [STEAMPIPE_CACHE_MAX_SIZE_MB](reference/env-vars/steampipe_cache_max_size_mb)| unlimited | Set the maximum size of the query cache across all plugins.
| [STEAMPIPE_CACHE_MAX_SIZE_MB](reference/env-vars/steampipe_cache_max_size_mb)| unlimited | Set the maximum size of the query cache across all plugins. [DEPRECATED - use `STEAMPIPE_PLUGIN_MEMORY_MAX_MB`].
| [STEAMPIPE_CACHE_MAX_TTL](reference/env-vars/steampipe_cache_max_ttl)| `300` | The maximum amount of time to cache results, in seconds.
| [STEAMPIPE_CACHE_TTL](reference/env-vars/steampipe_cache_ttl)| `300` | The amount of time to cache results, in seconds.
| [STEAMPIPE_CLOUD_HOST](reference/env-vars/steampipe_cloud_host) | `pipes.turbot.com` | Set the Turbot Pipes host, for connecting to Turbot Pipes workspace.
Expand All @@ -28,16 +28,17 @@ Note that plugins may also support environment variables, but these are plugin-s
| [STEAMPIPE_DIAGNOSTIC_LEVEL](reference/env-vars/steampipe_diagnostic_level)| `NONE` | Sets the diagnostic level. Supported levels are `ALL`, `NONE`.
| [STEAMPIPE_INSTALL_DIR](reference/env-vars/steampipe_install_dir)| `~/.steampipe` | The directory in which the Steampipe database, plugins, and supporting files can be found.
| [STEAMPIPE_INTROSPECTION](reference/env-vars/steampipe_introspection) | `none` | Enable introspection tables that allow you to query the mod resources in the workspace.
| [STEAMPIPE_LOG](reference/env-vars/steampipe_log) | `warn` | Set the logging output level [DEPRECATED - use STEAMPIPE_LOG_LEVEL].
| [STEAMPIPE_LOG](reference/env-vars/steampipe_log) | `warn` | Set the logging output level [DEPRECATED - use `STEAMPIPE_LOG_LEVEL`].
| [STEAMPIPE_LOG_LEVEL](reference/env-vars/steampipe_log) | `warn` | Set the logging output level.
| [STEAMPIPE_MAX_PARALLEL](reference/env-vars/steampipe_max_parallel) | `10` | Set the maximum number of parallel executions.
| [STEAMPIPE_MEMORY_MAX_MB](reference/env-vars/steampipe_memory_max_mb)| `1024` | Set a soft memory limit for the `steampipe` process.
| [STEAMPIPE_MOD_LOCATION](reference/env-vars/steampipe_mod_location) | current working directory | Set the workspace working directory.
| [STEAMPIPE_OTEL_INSECURE](reference/env-vars/steampipe_otel_insecure) | `false` | Bypass the SSL/TLS secure connection requirements when connecting to an OpenTelemetry server.
| [STEAMPIPE_OTEL_LEVEL](reference/env-vars/steampipe_otel_level) | `NONE` | Specify which [OpenTelemetry](https://opentelemetry.io/) data to send via OTLP.
| [STEAMPIPE_PLUGIN_MEMORY_MAX_MB](reference/env-vars/steampipe_plugin_memory_max_mb)| `1024` | Set a default memory soft limit for each plugin process.
| [STEAMPIPE_QUERY_TIMEOUT](reference/env-vars/steampipe_query_timeout) | `240` for controls, unlimited in all other cases. | Set the amount of time to wait for a query to complete before timing out, in seconds.
| [STEAMPIPE_SNAPSHOT_LOCATION](/docs/reference/env-vars/steampipe_snapshot_location) | The Turbot Pipes user's personal workspace | Set the Turbot Pipes workspace or filesystem path for writing snapshots.
| [STEAMPIPE_TELEMETRY](reference/env-vars/steampipe_telemetry) | `info` | Set the level of telemetry data to collect and send.
| [STEAMPIPE_UPDATE_CHECK](reference/env-vars/steampipe_update_check)| `true` | Enable/disable automatic update checking.
| [STEAMPIPE_WORKSPACE](reference/env-vars/steampipe_workspace) | `default` | Set the Steampipe workspace . This can be named workspace from `workspaces.spc` or a remote Turbot Pipes workspace| [STEAMPIPE_WORKSPACE_CHDIR](reference/env-vars/steampipe_workspace_chdir) | current working directory | Set the workspace working directory. [DEPRECATED - use `STEAMPIPE_MOD_LOCATION`].
| [STEAMPIPE_WORKSPACE](reference/env-vars/steampipe_workspace) | `default` | Set the Steampipe workspace . This can be named workspace from `workspaces.spc` or a remote Turbot Pipes workspace
| [STEAMPIPE_WORKSPACE_DATABASE](reference/env-vars/steampipe_workspace_database) | `local` | Workspace database. This can be `local` or a remote Turbot Pipes database.
6 changes: 6 additions & 0 deletions docs/reference/env-vars/steampipe_cache_max_size_mb.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ sidebar_label: STEAMPIPE_CACHE_MAX_SIZE_MB
---

# STEAMPIPE_CACHE_MAX_SIZE_MB


***`STEAMPIPE_CACHE_MAX_SIZE_MB` is deprecated and will be removed in a future version of Steampipe. Use `STEAMPIPE_PLUGIN_MEMORY_MAX_MB` to manage memory limits for plugins***



Set the maximum size (in MB) of the query cache across all plugins.

If `STEAMPIPE_CACHE_MAX_SIZE_MB` is set, Steampipe will limit the query cache ***across all plugins*** to the specified size. Each plugin version runs in a separate process, and each plugin process has its own cache. When `STEAMPIPE_CACHE_MAX_SIZE_MB` is set, Steampipe divides the cache based on the total number of connections and allocates memory shares to each plugin process based on the number of connections for that plugin.
Expand Down
16 changes: 16 additions & 0 deletions docs/reference/env-vars/steampipe_otel_insecure.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: STEAMPIPE_OTEL_INSECURE
sidebar_label: STEAMPIPE_OTEL_INSECURE
---
# STEAMPIPE_OTEL_INSECURE

Set the `STEAMPIPE_OTEL_INSECURE` to bypass the default secure connection requirements when connecting to an OpenTelemetry server. This enables steampipe to communicate with the OpenTelemetry server without needing SSL/TLS encryption. This can be useful for local testing or when operating within a secure, isolated network where encryption may not be deemed necessary.

## Usage

If you are connecting to a local insecure OpenTelemetry server:

```bash
export OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:16686/
export STEAMPIPE_OTEL_INSECURE=true
```
17 changes: 0 additions & 17 deletions docs/reference/env-vars/steampipe_workspace_chdir.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -201,14 +201,14 @@
"reference/env-vars/steampipe_max_parallel",
"reference/env-vars/steampipe_memory_max_mb",
"reference/env-vars/steampipe_mod_location",
"reference/env-vars/steampipe_otel_insecure",
"reference/env-vars/steampipe_otel_level",
"reference/env-vars/steampipe_plugin_memory_max_mb",
"reference/env-vars/steampipe_query_timeout",
"reference/env-vars/steampipe_snapshot_location",
"reference/env-vars/steampipe_telemetry",
"reference/env-vars/steampipe_update_check",
"reference/env-vars/steampipe_workspace",
"reference/env-vars/steampipe_workspace_chdir",
"reference/env-vars/steampipe_workspace_database"
]
},
Expand Down
Loading