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

Improve table docs #31

Closed
wants to merge 1 commit into from
Closed
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
19 changes: 16 additions & 3 deletions docs/tables/hcloud_action.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: hcloud_action
---
title: "Steampipe Table: hcloud_action - Query Hetzner Cloud Actions using SQL"
description: "Allows users to query Actions in Hetzner Cloud, specifically the status and progress of actions taken on resources, providing insights into resource management and potential issues."
---

Query actions from your Hetzner Cloud account.
# Table: hcloud_action - Query Hetzner Cloud Actions using SQL

Hetzner Cloud Actions are tasks performed on resources within the Hetzner Cloud platform. These actions include tasks such as creating, updating, or deleting resources like servers, volumes, and networks. Each action has a status and progress which can be tracked to understand the outcome of the task.

## Table Usage Guide

The `hcloud_action` table provides insights into actions taken within Hetzner Cloud. As a system administrator, explore action-specific details through this table, including statuses, progress, and associated metadata. Utilize it to monitor the progress and outcomes of tasks, such as resource creation, updates, and deletions, and to identify any potential issues that may arise during these processes.

## Examples

### List create_server actions
Explore instances where server creation actions have been initiated to gain insights into system activity and manage resources effectively. This can be particularly useful for tracking resource allocation and identifying areas for optimization.

```sql
select
Expand All @@ -16,6 +26,7 @@ where
```

### Get a specific action
Analyze the settings to understand the specifics of a particular action in your Hetzner Cloud environment. This can be useful in identifying changes or actions that could impact system performance or security.

```sql
select
Expand All @@ -27,6 +38,7 @@ where
```

### Actions in error
Discover instances where actions have failed to execute correctly, allowing for the identification and resolution of potential issues within your system. This is crucial for maintaining optimal system performance and stability.

```sql
select
Expand All @@ -38,6 +50,7 @@ where
```

### All actions related to a given server
Identify instances where specific server-related actions have taken place. This can help in monitoring server activity, providing insights into system usage and behavior patterns.

```sql
select
Expand All @@ -48,4 +61,4 @@ from
where
r->>'Type' = 'server'
and (r->'ID')::int = 14462596
```
```
18 changes: 15 additions & 3 deletions docs/tables/hcloud_datacenter.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: hcloud_datacenter
---
title: "Steampipe Table: hcloud_datacenter - Query Hetzner Cloud Datacenters using SQL"
description: "Allows users to query Datacenters in Hetzner Cloud, specifically the location, server types, and availability, providing insights into datacenter distribution and potential capacity."
---

List data centers for the Hetzner Cloud account.
# Table: hcloud_datacenter - Query Hetzner Cloud Datacenters using SQL

Hetzner Cloud Datacenters are physical locations around the world where Hetzner Cloud servers reside. They are designed to be highly reliable, secure, and efficient. These datacenters contain the server types and their availability, which are crucial for planning and managing cloud resources.

## Table Usage Guide

The `hcloud_datacenter` table provides insights into datacenters within Hetzner Cloud. As a system administrator or DevOps engineer, explore datacenter-specific details through this table, including location, server types, and availability. Utilize it to uncover information about datacenters, such as their geographical distribution, the types of servers available, and their current availability status.

## Examples

### List all data centers
Explore the various data centers available, ordered by their names, to better manage resources and optimize performance. This can be particularly useful when planning the deployment of new services or assessing existing infrastructure.

```sql
select
Expand All @@ -16,6 +26,7 @@ order by
```

### Get data center by name
Explore which specific data center is associated with a certain name, allowing you to quickly identify and access relevant data center information for further analysis or management tasks. This is particularly useful in environments with multiple data centers, where locating specific ones by name can streamline administrative tasks.

```sql
select
Expand All @@ -27,6 +38,7 @@ where
```

### Get all available server types for all data centers
Explore the variety of server types across all data centers. This is useful for understanding the diverse server options available for different data center deployments, aiding in strategic decision-making and resource allocation.

```sql
select
Expand All @@ -38,4 +50,4 @@ from
hcloud_server_type as st
where
sta::int = st.id
```
```
17 changes: 14 additions & 3 deletions docs/tables/hcloud_image.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: hcloud_image
---
title: "Steampipe Table: hcloud_image - Query Hetzner Cloud Images using SQL"
description: "Allows users to query Images in Hetzner Cloud, specifically the image ID, type, status, and other related information, providing insights into the various system images and snapshots available in the cloud environment."
---

List images for the Hetzner Cloud account.
# Table: hcloud_image - Query Hetzner Cloud Images using SQL

Hetzner Cloud Images are system images and snapshots that can be used to create new servers. These images include pre-configured operating systems, applications, and configurations that are stored in Hetzner Cloud. They can be public (provided by Hetzner), private (custom images created by users), or snapshots created from existing servers.

## Table Usage Guide

The `hcloud_image` table provides insights into images within Hetzner Cloud. As a cloud administrator, explore image-specific details through this table, including image type, status, and associated metadata. Utilize it to uncover information about images, such as their description, source server, and the last time they were updated.

## Examples

### List all images
Explore all available images in your system to gain a better understanding of your resources. This can be useful for managing and organizing your digital assets.

```sql
select
Expand All @@ -18,6 +28,7 @@ order by
```

### Find all deprecated images
Uncover the details of outdated images within your system to better manage and update your resources for optimal performance.

```sql
select
Expand All @@ -29,4 +40,4 @@ from
hcloud_image
where
deprecated is not null
```
```
17 changes: 14 additions & 3 deletions docs/tables/hcloud_location.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: hcloud_location
---
title: "Steampipe Table: hcloud_location - Query Hetzner Cloud Locations using SQL"
description: "Allows users to query Locations in Hetzner Cloud, specifically the data center locations where resources can be deployed, providing insights into available regions and their respective details."
---

List locations for the Hetzner Cloud account.
# Table: hcloud_location - Query Hetzner Cloud Locations using SQL

A Hetzner Cloud Location represents a data center where resources can be deployed. These locations are geographically distributed and are used to host the virtual machines (servers) and other resources provided by Hetzner Cloud. Each location has a unique name and provides different features and services.

## Table Usage Guide

The `hcloud_location` table provides insights into the data center locations within Hetzner Cloud. As a system administrator or a DevOps engineer, explore location-specific details through this table, including the name, description, and network zone of each location. Utilize it to uncover information about availability and features of each location, aiding in the strategic deployment of resources.

## Examples

### List all locations
Explore the various locations available in your Hetzner Cloud infrastructure, arranged in alphabetical order. This is particularly useful for understanding your geographical distribution and planning for data redundancy and latency optimization.

```sql
select
Expand All @@ -16,6 +26,7 @@ order by
```

### Get location by name
Discover the specifics of a particular location within the Hetzner Cloud service. This query can be used to gain insights into the settings and configuration of a chosen location, which is beneficial for planning and managing resources.

```sql
select
Expand All @@ -24,4 +35,4 @@ from
hcloud_location
where
name = 'hel1'
```
```
18 changes: 15 additions & 3 deletions docs/tables/hcloud_network.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: hcloud_network
---
title: "Steampipe Table: hcloud_network - Query Hetzner Cloud Networks using SQL"
description: "Allows users to query Networks in Hetzner Cloud, providing insights into the network infrastructure and configurations."
---

List networks for the Hetzner Cloud account.
# Table: hcloud_network - Query Hetzner Cloud Networks using SQL

Hetzner Cloud Networks is a service within Hetzner Cloud that allows users to manage and configure their network infrastructure. It provides a centralized way to set up and manage networks for various resources, such as virtual machines and databases. Hetzner Cloud Networks helps users to maintain the health and performance of their network resources, and take appropriate actions when predefined conditions are met.

## Table Usage Guide

The `hcloud_network` table provides insights into networks within Hetzner Cloud. As a network administrator, explore network-specific details through this table, including network configurations, associated subnets, and IP ranges. Utilize it to uncover information about networks, such as their IP ranges, associated resources, and the overall structure of your network infrastructure.

## Examples

### List all networks
Explore all the networks available in your environment, ordered by their ID. This can assist in identifying and understanding the various networks in use, which is crucial for effective network management and security.

```sql
select
Expand All @@ -18,6 +28,7 @@ order by
```

### List all networks with the label env=prod
Explore which networks are labeled as 'production environment'. This is beneficial for managing and distinguishing your production systems from development or testing systems, ensuring the right resources are allocated and maintained.

```sql
select
Expand All @@ -31,6 +42,7 @@ where
```

### List all servers in the network
Explore which servers are part of your network. This can help you manage and monitor your network infrastructure more effectively.

```sql
select
Expand All @@ -43,4 +55,4 @@ from
hcloud_server as s
where
s.id = sid::int
```
```
18 changes: 15 additions & 3 deletions docs/tables/hcloud_placement_group.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: hcloud_placement_group
---
title: "Steampipe Table: hcloud_placement_group - Query Hetzner Cloud Placement Groups using SQL"
description: "Allows users to query Placement Groups in Hetzner Cloud, providing details about placement groups which are used to determine the physical location of servers."
---

List placement groups for the Hetzner Cloud account.
# Table: hcloud_placement_group - Query Hetzner Cloud Placement Groups using SQL

A Placement Group in Hetzner Cloud is a resource used to determine the physical location of servers. It provides an overview of the server's placement group, including its type and servers. The placement group's type can be either "spread" or "cluster", and it is used to control the distribution of servers within the same data center.

## Table Usage Guide

The `hcloud_placement_group` table provides insights into Placement Groups within Hetzner Cloud. As a Cloud Engineer, you can explore placement group-specific details through this table, including their type and associated servers. Utilize it to manage the distribution of servers within the same data center, ensuring optimal performance and availability.

## Examples

### List placement groups
Explore the organization of your server infrastructure by identifying the groups in which your servers are placed. This can help to understand the distribution and categorization of your servers, thereby aiding in efficient resource management.

```sql
select
Expand All @@ -19,6 +29,7 @@ order by
```

### List placement groups with the label env=prod
Discover the segments that have been labeled as 'production environment' within your placement groups. This is useful for understanding how resources are allocated and managed within your production environment.

```sql
select
Expand All @@ -33,6 +44,7 @@ where
```

### Get server details for servers in placement groups
This query is useful for identifying the status and other details of servers located within specific placement groups. This can help in managing and monitoring server performance and resource allocation more effectively.

```sql
with placement_groups as (
Expand All @@ -56,4 +68,4 @@ from
hcloud_server as s
where
s.id::text = p.server_id::text;
```
```
20 changes: 17 additions & 3 deletions docs/tables/hcloud_server.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: hcloud_server
---
title: "Steampipe Table: hcloud_server - Query Hetzner Cloud Servers using SQL"
description: "Allows users to query Hetzner Cloud Servers, specifically the servers' details like ID, name, status, data center location, and more."
---

List servers for the Hetzner Cloud account.
# Table: hcloud_server - Query Hetzner Cloud Servers using SQL

Hetzner Cloud is a cloud infrastructure solutions provider that offers scalable and cost-effective cloud servers. These servers are located in multiple data centers across the globe, providing high-performance and reliable cloud services. Hetzner Cloud servers are ideal for a wide range of applications, including web hosting, development environments, and high-traffic websites.

## Table Usage Guide

The `hcloud_server` table offers insights into the servers hosted on Hetzner Cloud. As a system administrator or a DevOps engineer, you can explore server-specific details through this table, including server status, location, type, and associated metadata. Use it to monitor server availability, manage server resources, and track the performance of your cloud infrastructure.

## Examples

### List all servers
Explore a comprehensive list of all servers in a structured order based on their names. This is useful for maintaining an organized inventory of servers and simplifying server management tasks.

```sql
select
Expand All @@ -16,6 +26,7 @@ order by
```

### Get server by name
Discover the segments that pertain to a specific server by its name. This is particularly useful in a scenario where you want to understand the configuration and details of a specific server within your infrastructure.

```sql
select
Expand All @@ -27,6 +38,7 @@ where
```

### List servers with IPs
Explore which servers have assigned IP addresses, both private and public. This could be useful for network management and troubleshooting connectivity issues.

```sql
select
Expand All @@ -42,6 +54,7 @@ order by
```

### List servers with server type information
Explore which servers are associated with specific server types, including details like the number of cores and CPU type. This can be beneficial in managing resources and understanding hardware specifications across your server infrastructure.

```sql
select
Expand All @@ -57,6 +70,7 @@ where
```

### List all volumes for all servers
Determine the areas in which server storage is being utilized by listing all volumes across all servers. This can help in assessing storage distribution and planning for capacity management.

```sql
select
Expand All @@ -69,4 +83,4 @@ from
hcloud_volume as v
where
sv::int = v.id
```
```
17 changes: 14 additions & 3 deletions docs/tables/hcloud_server_type.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Table: hcloud_server_type
---
title: "Steampipe Table: hcloud_server_type - Query Hetzner Cloud Server Types using SQL"
description: "Allows users to query Server Types in Hetzner Cloud, specifically the details of each server type, providing insights into available server configurations and their characteristics."
---

List server types for the Hetzner Cloud account.
# Table: hcloud_server_type - Query Hetzner Cloud Server Types using SQL

Hetzner Cloud Server Types are predefined configurations of servers available for use in Hetzner Cloud. Each server type comes with a specific set of resources, such as CPU cores, memory, and disk space. These server types are designed to accommodate a wide range of computing needs, from small-scale applications to large-scale enterprise projects.

## Table Usage Guide

The `hcloud_server_type` table provides insights into the server types within Hetzner Cloud. As a system administrator or a DevOps engineer, explore server type-specific details through this table, including CPU cores, memory, disk size, and more. Utilize it to uncover information about server types, such as those with specific resource configurations, to help in selecting the most suitable server type for your application or project.

## Examples

### List all server types
Discover the different server types available in your infrastructure, which can help you understand your resource distribution and inform decisions about capacity planning or resource allocation.

```sql
select
Expand All @@ -17,6 +27,7 @@ order by
```

### Get all server types with pricing
Explore various server types alongside their pricing details to make informed decisions about cost management and resource allocation. This can help in optimizing your spending by choosing the most cost-effective server type for your needs.

```sql
select
Expand All @@ -29,4 +40,4 @@ from
jsonb_array_elements(st.prices) as p
order by
hourly_net
```
```
Loading