Skip to content

Commit

Permalink
remove container docs, add faq
Browse files Browse the repository at this point in the history
  • Loading branch information
johnsmyth committed Mar 8, 2024
1 parent 260d935 commit 7d2c3b6
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 315 deletions.
17 changes: 17 additions & 0 deletions docs/faq/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: FAQ
sidebar_label: FAQ
---

# FAQ

## Where is the Dockerfile or container example?

Steampipe can be run in a containerized setup. We run it ourselves that way as part of [Turbot Pipes](https://turbot.com/pipes). However, we don't publish or support a container definition because:

* The CLI is optimized for developer use on the command line.
* Everyone has specific goals and requirements for their containers.
* Container setup requires various mounts and access to configuration files.
* It's hard to support containers across many different environments.

We welcome users to create and share open-source container definitions for Steampipe.
309 changes: 0 additions & 309 deletions docs/managing/containers.md

This file was deleted.

6 changes: 2 additions & 4 deletions docs/managing/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ sidebar_label: Manage Steampipe

# Manage Steampipe

Steampipe is simple to install and manage, and does not require any special expertise to get started. You will need to [install and update plugins](managing/plugins) and [manage connections](managing/connections), but any other configuration is optional.
Steampipe is simple to install and manage and does not require any special expertise to get started. You will need to [install and update plugins](managing/plugins) and [manage connections](managing/connections), but any other configuration is optional.

If you wish, you may [run Steampipe a local service](managing/service), exposing the database endpoint for connection from any Postgres-compatible database client and sharing the steampipe dashboard web server.

You can also [run steampipe in a container](managing/containers) if you prefer.
If you wish, you may [run Steampipe as a local service](managing/service), exposing the database endpoint for connection from any Postgres-compatible database client and sharing the Steampipe dashboard web server.
10 changes: 8 additions & 2 deletions docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,7 @@
"managing/service",
"managing/plugins",
"managing/connections",
"managing/workspaces",
"managing/containers"
"managing/workspaces"
]
},
{
Expand Down Expand Up @@ -291,5 +290,12 @@
"steampipe_export/install",
"steampipe_export/run"
]
},

{
"type": "category",
"id": "faq",
"link": "faq/overview",
"items": []
}
]

0 comments on commit 7d2c3b6

Please sign in to comment.