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

build(deps): bump Docusaurus to v3 #916

Merged
merged 1 commit into from
Dec 7, 2023
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,10 @@
"jsx-a11y/no-noninteractive-tabindex": 0,
"jsx-a11y/no-onchange": "off",
"no-console": 1,
"no-unused-vars": "off"
"no-unused-vars": "off",
"prettier/prettier": ["error", { "endOfLine": "auto" }],
"react/jsx-uses-react": "off",
"react/react-in-jsx-scope": "off"
},
"reportUnusedDisableDirectives": true,
"settings": {
Expand Down
2 changes: 1 addition & 1 deletion blog/a-walk-in-the-graph/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Nodes represent resources, while edges define the relationship between nodes. It

![Sheep Jumping on a Graph](./img/banner.png)

<!--truncate-->
{/* truncate */}

This model makes it easy to capture not only the structure, but also makes the relationships explicit. You can think of the graph as a digital twin of your infrastructure metadata. Resoto allows you to explore and extract meaningful information from your infrastructure with a simple search.

Expand Down
2 changes: 1 addition & 1 deletion blog/actionable-cloud-infrastructure-metrics/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Even those spinning up cloud resources might only be aware of their small slice

[Cloud inventory](../cloud-asset-inventory/index.mdx) has become a new type of technical debt, where organizations lose track of their infrastructure and how it relates to the business. **Resoto helps to break open the aforementioned black box and eliminate inventory debt.**

<!--truncate-->
{/* truncate */}

Resoto provides a [searchable](/docs/reference/search) snapshot of the current state of your cloud infrastructure, and can [automatically react to state changes](/docs/concepts/automation). Resoto also allows you to [aggregate](../aggregating-search-data/index.mdx) and [visualize](../resoto-meets-jupyter-notebook/index.mdx) this data.

Expand Down
2 changes: 1 addition & 1 deletion blog/aggregating-search-data/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Resoto's search allows for resources to be selected using [filters](/docs/refere

![Left: Sheep Finding a Diamond in a Gold Mine](./img/banner.png)

<!--truncate-->
{/* truncate */}

The simplest example of search aggregation in Resoto is the [`count` command](/docs/reference/cli/count), which enables you to count objects or the occurrences of a specific property. Let's say we are interested in the number of compute instances we maintain:

Expand Down
2 changes: 1 addition & 1 deletion blog/automating-pagerduty-infrastructure-alerts/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ For example, if a resource is no longer needed, it should be cleaned up to avoid

Resoto provides tools to cope with such challenges. **In this post, we'll explore another category of high-priority issues that often require immediate attention: breaches in the security baseline.**

<!--truncate-->
{/* truncate */}

## Security Baselines

Expand Down
29 changes: 2 additions & 27 deletions blog/building-a-web-app-with-streamlit/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In [Actionable Cloud Infrastructure Metrics](../actionable-cloud-infrastructure-

If you are not familiar with [Python](https://python.org), don't worry—we're going to keep it simple! In [Prerequisites](#prerequisites), we'll go over installing Python and the coding techniques utilized in this project.

<!--truncate-->
{/* truncate */}

:::info

Expand Down Expand Up @@ -45,7 +45,6 @@ If you already these prerequisites installed, you can skip ahead to [Environment
### Python and `pip`

<Tabs groupId="operating-system">

<TabItem value="linux" label="Linux">

On Linux, there is a good chance the distro already comes with a version of Python 3.x installed. If you are not sure, you can check with the following command:
Expand All @@ -60,7 +59,6 @@ $ python3 --version
If the command returns an error, you can install Python and `pip` using your distro's package manager:

<Tabs groupId="linux-distro">

<TabItem value="debian" label="Debian/Ubuntu">

```bash
Expand All @@ -69,31 +67,24 @@ $ sudo apt install python3 python3-pip
```

</TabItem>

<TabItem value="fedora" label="Fedora/CentOS">

```bash
$ sudo dnf install python3 python3-pip
```

</TabItem>

</Tabs>

</TabItem>

<TabItem value="macos" label="macOS">

<Tabs>

<TabItem value="download" label="Download">

You can download the latest version of Python for macOS from [Python.org](https://python.org/downloads):

![Screenshot of python.org](./img/download-python-macos.png)

</TabItem>

<TabItem value="homebrew" label="Homebrew">

With [Homebrew](https://brew.sh), you can install Python by executing the following command in the **Terminal** app:
Expand All @@ -111,23 +102,17 @@ The **Terminal** app can be found under **Utilities** within the **Applications*
:::

</TabItem>

</Tabs>

</TabItem>

<TabItem value="windows" label="Windows">

<Tabs>

<TabItem value="download" label="Download">

You can download the latest version of Python for Windows from [Python.org](https://python.org/downloads):

![Screenshot of python.org](./img/download-python-windows.png)

</TabItem>

<TabItem value="chocolatey" label="Chocolatey">

With [Chocolatey](https://chocolatey.org), you can install Python by executing the following command:
Expand All @@ -137,21 +122,15 @@ choco install python
```

</TabItem>

</Tabs>

</TabItem>

</Tabs>

If you don't have prior Python or programming experience, please read the following overview of some Python basics before proceeding:

<details>

<summary>Python Basics</summary>

<div>

<h4 id="starting-the-repl">Starting the REPL</h4>

Start Python by running the following command (in PowerShell on Windows or the Terminal app on macOS):
Expand Down Expand Up @@ -340,7 +319,6 @@ Multiple conditions can be checked using the `and` and `or` operators:
```

</div>

</details>

### Resoto
Expand Down Expand Up @@ -447,7 +425,7 @@ If you are interested in different resource types or metrics, you can easily ada
numpy
```

:::caution
:::warning

In production environments, you should pin the version of each package (e.g., `resotolib==2.4.1`).

Expand Down Expand Up @@ -1045,9 +1023,7 @@ Finally, we will add a histogram of the instance age distribution. (We're adding
### The Final Product

<details>

<summary>Complete App Code</summary>

<div>

```python title="app.py" showLineNumbers
Expand Down Expand Up @@ -1177,7 +1153,6 @@ age_tab.plotly_chart(fig, use_container_width=True)
```

</div>

</details>

## What's Next?
Expand Down
2 changes: 1 addition & 1 deletion blog/building-an-ec2-asset-inventory/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ You also then want to use that list to ask questions about your inventory, such

In this post, I'll describe how to use Resoto to build an EC2 [cloud asset inventory](../cloud-asset-inventory/index.mdx). The baseline inventory is a list with all EC2 instances, which you then can use to create more narrow and detailed views.

<!--truncate-->
{/* truncate */}

## Getting Started with Resoto

Expand Down
2 changes: 1 addition & 1 deletion blog/cloud-asset-inventory/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ In modern cloud-native environments, developers enjoy freedom and permissions to

**A cloud asset inventory solves the infrastructure fragmentation problem by providing complete visibility into all resources from a single place.**

<!--truncate-->
{/* truncate */}

## The Evolution of Cloud Offerings and New Challenges

Expand Down
2 changes: 1 addition & 1 deletion blog/cloud-resource-security-benchmarks/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ While security benchmarks are often associated with large corporations, they pro

In this blog post, we'll explore the benefits of performing security benchmarks on your cloud resources and introduce [Resoto Sentinel](/sentinel), the Resoto security module designed to simplify the benchmarking process.

<!--truncate-->
{/* truncate */}

## Security Benchmark Rationale

Expand Down
5 changes: 1 addition & 4 deletions blog/cloud-resource-tagging/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ In theory, this is the correct way to manage resources; in practice, however, th

And, to properly use tagging on a greenfield cloud account is one thing; to retroactively apply tags to sprawling cloud infrastructure is quite another (especially when utilizing a multi-cloud strategy, where you'd need to repeat any operation over multiple interfaces).

<!--truncate-->
{/* truncate */}

We asked our community about their most challenging aspect of cloud tagging strategies on [LinkedIn](https://linkedin.com/feed/update/urn:li:activity:6987739499686428672):

Expand Down Expand Up @@ -135,7 +135,6 @@ While the constant cleaning up behind your developers is now entirely hands-off,
In addition to a repair job, you can also set up notifications for your team to alert them of wrong tags, providing an opportunity to fix the root cause (e.g., Cloudformation templates or Terraform config files):

<Tabs>

<TabItem value="discord" label="Discord">

```bash title="Create a job to send notifications of untagged resources to Discord"
Expand All @@ -144,7 +143,6 @@ webhook="https://discord.com/api/webhooks/..."'
```

</TabItem>

<TabItem value="slack" label="Slack">

:::info
Expand All @@ -161,7 +159,6 @@ webhook="https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXX
```

</TabItem>

</Tabs>

See [Alerting How-To Guides](/docs/how-to-guides/alerting) for additional notification options.
Expand Down
5 changes: 1 addition & 4 deletions blog/cloud-security-compliance/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The concept and rationale of security compliance and how to build a baseline wer

:::

<!--truncate-->
{/* truncate */}

## Challenges to Security Compliance

Expand Down Expand Up @@ -102,23 +102,20 @@ This outputs a file `report.md` in the [Resoto Shell download directory](/docs/r
Resoto can not only output security benchmark reports to a file, but can also send results to [Discord](/docs/how-to-guides/alerting/send-discord-notifications) or [Slack](/docs/how-to-guides/alerting/send-slack-notifications):

<Tabs>

<TabItem value="discord" label="Discord">

```bash
> report benchmark run aws_cis_1_5 --accounts 7524xxxx --only-failing --only-check-results | discord --title "Security Benchmark Issues!\nAccount 7524xxxx does not adhere to AWS CIS 1.5" --key .name --value .number_of_resources_failing --webhook https://discord.com/api/webhooks/123/234
```

</TabItem>

<TabItem value="slack" label="Slack">

```bash
> report benchmark run aws_cis_1_5 --accounts 7524xxxx --only-failing --only-check-results | slack --title "Security Benchmark Issues!\nAccount 7524xxxx does not adhere to AWS CIS 1.5" --key .name --value .number_of_resources_failing --webhook https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX
```

</TabItem>

</Tabs>

If the [`report` command](/docs/reference/cli/report) finds any issues, a message like the following will be sent:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Welcome to my first blog post! I'm Raffa and I'm excited to share a new feature

![Resoto UI Job Editor](./img/banner.jpg)

<!--truncate-->
{/* truncate */}

As I was building the jobs editor, I found myself gaining a newfound appreciation and deeper understanding of [Resoto jobs](/docs/concepts/automation#jobs).

Expand Down
4 changes: 2 additions & 2 deletions blog/digitalocean-support/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ I worked on a plugin that allows collecting DigitalOcean resources over the past

![Sheep Sailing Through DigitalOcean](./img/banner.png)

<!--truncate-->
{/* truncate */}

## Getting Started

Expand Down Expand Up @@ -55,7 +55,7 @@ Once the DigitalOcean plugin configuration has been updated, trigger a collect r
> workflows run collect
```

<!--truncate-->
{/* truncate */}

## Searching the Graph

Expand Down
2 changes: 1 addition & 1 deletion blog/discover-kubernetes-resources/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Even a relatively simple setup quickly becomes tedious to manage as the resource

![](./img/banner.png)

<!--truncate-->
{/* truncate */}

## Kubernetes Support in Resoto

Expand Down
2 changes: 1 addition & 1 deletion blog/effective-cloud-management-tagging-policies/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Managing and tracking cloud resources can be challenging, especially when multip

In this blog post, we'll provide a brief overview of the benefits of implementing a tagging policy and best practices for creating and enforcing it, based on our [recently published white paper](https://cdn.some.engineering/resoto/whitepaper/Resoto_Cloud_Tagging_Strategy_White_Paper.pdf).

<!--truncate-->
{/* truncate */}

## Benefits of Tagging Policies

Expand Down
2 changes: 1 addition & 1 deletion blog/how-d2iq-reduced-cloud-spend-using-resoto/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: D2iQ, an entireprise Kubernetes provider, used Resoto to reduce the

In this post, I share the story of how [D2iQ](https://d2iq.com), an enterprise Kubernetes provider, used Resoto to reduce their annual cloud bill by 78% and save $5.4M per year.

<!--truncate-->
{/* truncate */}

## The Challenge

Expand Down
13 changes: 2 additions & 11 deletions blog/installing-cloud2sql/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Whether you are looking to integrate cloud data into your existing SQL workflows

<AsciinemaPlayer src={require('./asciinema/cloud2sql.cast').default} cols={80} rows={20} preload={true} autoPlay={true} loop={true} />

<!--truncate-->
{/* truncate */}

## Installation

Expand All @@ -31,7 +31,7 @@ If you only require support for a specific database, you can choose between `clo

:::

:::caution
:::warning

Snowflake currently only supports Python 3.10. If you are using Python 3.11, use a database-specific package instead of `cloud2sql[all]`.

Expand All @@ -58,13 +58,9 @@ destinations:
This tells Cloud2SQL to load the AWS collector. Within the `aws` section, you can configure additional options, but they are optional.

<details>

<summary>Advanced configuration examples</summary>

<div>

<Tabs>

<TabItem value="aws-snowflake" label="AWS / K8S / Snowflake">

```yaml
Expand Down Expand Up @@ -113,7 +109,6 @@ destinations:
```

</TabItem>

<TabItem value="gcp-postgres" label="Google Cloud / PostgreSQL">

```yaml
Expand All @@ -135,7 +130,6 @@ sources:
```

</TabItem>

<TabItem value="do-parquet" label="DigitalOcean / Parquet">

```yaml
Expand All @@ -152,11 +146,8 @@ destinations:
```

</TabItem>

</Tabs>

</div>

</details>

See [`config-template.yaml`](https://github.com/someengineering/cloud2sql/blob/main/config-template.yaml) for a list of all supported configuration options.
Expand Down
Loading