Skip to content

Commit

Permalink
Mark aws/k8s/digitalocean installation as deprecated (#949)
Browse files Browse the repository at this point in the history
Co-authored-by: TheCatLady <[email protected]>
  • Loading branch information
aquamatthias and TheCatLady authored Jan 19, 2024
1 parent fc6cc65 commit c748d97
Show file tree
Hide file tree
Showing 34 changed files with 406 additions and 205 deletions.
2 changes: 1 addition & 1 deletion blog/building-a-web-app-with-streamlit/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ Now that we've set up the project environment, we can start creating the infrast

</details>

2. Modify the `url` and `psk` values to match your local Resoto Core URL and pre-shared key. The above reflects the default values for a [Docker Compose install](/docs/getting-started/install-resoto/docker).
2. Modify the `url` and `psk` values to match your local Resoto Core URL and pre-shared key. The above reflects the default values.

3. Save the file and switch back to the terminal.

Expand Down
6 changes: 6 additions & 0 deletions docs/getting-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,10 @@ pagination_next: null

This section of the documentation walks you through how to [install](./install-resoto/index.mdx) and [configure](./configure-resoto/index.mdx) Resoto, step by step.

:::tip

Don't want to manage your own Resoto installation? Check out **[Fix](https://fix.tt)**, an all-in-one security dashboard built on top of Resoto.

:::

<DocCardList />
15 changes: 14 additions & 1 deletion docs/getting-started/install-resoto/aws/cdk.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,31 @@ sidebar_label: Cloud Development Kit
sidebar_position: 2
pagination_prev: getting-started/index
pagination_next: getting-started/launch-resoto/index
unlisted: true
---

# Deploy Resoto to AWS with Cloud Development Kit

We provide a <abbr title="Cloud Development Kit">CDK</abbr> construct to simplify the deployment of Resoto to AWS.

:::tip
:::warning Deprecation notice

The Resoto <abbr title="Cloud Development Kit">CDK</abbr> construct is no longer actively maintained. We recommend [running Resoto using Docker](../index.mdx).

:::

:::info

The [Resoto web installer](./web-installer/index.mdx) is the easiest way to get a production-grade setup, whereas the CDK construct is a bit more involved but gives you more control over the setup and does not require you to send us your cloud credentials.

:::

:::tip

Don't want to manage your own Resoto installation? Check out **[Fix](https://fix.tt)**, an all-in-one security dashboard built on top of Resoto.

:::

## Prerequisites

- [Git](https://git-scm.com)
Expand Down
19 changes: 17 additions & 2 deletions docs/getting-started/install-resoto/aws/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,25 @@ pagination_next: getting-started/launch-resoto/index

We offer two ways of deploying Resoto to [Amazon Web Services (AWS)](https://aws.amazon.com): using the [Resoto web installer](./web-installer/index.mdx) or the Resoto [CDK construct](./cdk.mdx).

:::tip
:::warning Deprecation notice

The Resoto <abbr title="Cloud Development Kit">CDK</abbr> construct is no longer actively maintained. We recommend [running Resoto using Docker](../index.mdx).

:::

:::info

The [Resoto web installer](./web-installer/index.mdx) is the easiest way to get a production-grade setup, whereas the [CDK construct](./cdk.mdx) is a bit more involved but gives you more control over the setup and does not require you to send us your cloud credentials.

:::

<DocCardList />
:::tip

Don't want to manage your own Resoto installation? Check out **[Fix](https://fix.tt)**, an all-in-one security dashboard built on top of Resoto.

:::

<DocCardList items={[
{type: 'link', href: '/docs/edge/getting-started/install-resoto/aws/cdk', label: 'Cloud Development Kit', docId: 'getting-started/install-resoto/aws/cdk'},
{type: 'link', href: '/docs/edge/getting-started/install-resoto/aws/web-installer', label: 'Web Installer', docId: 'getting-started/install-resoto/aws/web-installer/index'}
]} />
21 changes: 17 additions & 4 deletions docs/getting-started/install-resoto/aws/web-installer/index.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,32 @@
---
sidebar_label: Resoto Web Installer
sidebar_label: Web Installer
sidebar_position: 1
pagination_prev: getting-started/index
pagination_next: getting-started/launch-resoto/index
unlisted: true
---

# Deploy Resoto to AWS with the Resoto Web Installer

We provide a web installer for one-click deployment of Resoto to <abbr title="Amazon Web Services">AWS</abbr>.
The Resoto web installer offers one-click deployment of Resoto to <abbr title="Amazon Web Services">AWS</abbr>.

:::tip
:::warning Deprecation notice

The Resoto web installer is no longer actively maintained. We recommend [running Resoto using Docker](../../index.mdx).

:::

:::info

When deploying Resoto, we only use provided AWS credentials for the deployment. Credentials are not stored or retained after the deployment is complete.

If you are not comfortable sharing your credentials, you can alternatively use the [CDK construct](../cdk.mdx) to deploy Resoto.
If you are not comfortable sharing your credentials, you can alternatively use the [CDK construct](../cdk.mdx) to deploy Resoto to AWS.

:::

:::tip

Don't want to manage your own Resoto installation? Check out **[Fix](https://fix.tt)**, an all-in-one security dashboard built on top of Resoto.

:::

Expand Down
13 changes: 13 additions & 0 deletions docs/getting-started/install-resoto/digitalocean/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,25 @@
sidebar_label: DigitalOcean
pagination_prev: getting-started/index
pagination_next: getting-started/launch-resoto/index
unlisted: true
---

# Deploy Resoto to DigitalOcean

You can deploy Resoto from the DigitalOcean Marketplace in just a few clicks.

:::warning Deprecation notice

The Resoto DigitalOcean Marketplace app is no longer actively maintained. We recommend [running Resoto using Docker](../index.mdx).

:::

:::tip

Don't want to manage your own Resoto installation? Check out **[Fix](https://fix.tt)**, an all-in-one security dashboard built on top of Resoto.

:::

1. Open Resoto in the DigitalOcean Marketplace:

[![Deploy Resoto to DigitalOcean](https://mp-assets1.sfo2.digitaloceanspaces.com/deploy-to-do/do-btn-blue.svg)](https://marketplace.digitalocean.com/app/resoto)
Expand Down
80 changes: 0 additions & 80 deletions docs/getting-started/install-resoto/docker.mdx

This file was deleted.

79 changes: 75 additions & 4 deletions docs/getting-started/install-resoto/index.mdx
Original file line number Diff line number Diff line change
@@ -1,19 +1,90 @@
---
sidebar_label: "1. Install Resoto"
sidebar_position: 1
sidebar_class_name: sidebar-install-resoto
pagination_label: Install Resoto
pagination_prev: getting-started/index
pagination_next: getting-started/launch-resoto/index
unlisted: false
---

# Install Resoto

Resoto can be deployed to [Amazon Web Services](./aws/index.mdx) or [DigitalOcean](./digitalocean/index.mdx), or installed via [Docker](./docker.mdx), [Kubernetes](./kubernetes.mdx), or [pip](./pip.mdx).
[Docker](https://docker.com) images allow Resoto to be run in a loosely isolated environment called a [container](https://docs.docker.com/get-started/overview#containers).

:::info
:::tip

Resoto consists of a number of distributed components that are intended to run 24/7 on a server. Running Resoto on a laptop will not provide a good user experience!
Don't want to manage your own Resoto installation? Check out **[Fix](https://fix.tt)**, an all-in-one security dashboard built on top of Resoto.

:::

<DocCardList />
## Prerequisites

- [Docker](https://docs.docker.com/get-started#download-and-install-docker)

- [Docker Compose >= 1.29](https://docs.docker.com/compose/install)

- At least 2 CPU cores and 8 GB of RAM

:::note

Resoto performs CPU-intensive graph operations. In a production setup, we recommend at least four cores and 16 gigabytes of RAM. See [Configuring Resoto Worker](../../reference/configuration/worker.mdx#multi-core-machines) for more information.

:::

## Directions

1. Fetch the required files from the [`someengineering/resoto` GitHub repository](https://github.com/someengineering/resoto):

```bash
$ mkdir -p resoto/dockerV2
$ cd resoto
$ curl -Lo docker-compose.yaml {{dockerComposeUrl}}
$ curl -Lo dockerV2/prometheus.yml https://raw.githubusercontent.com/someengineering/resoto/{{repoBranch}}/dockerV2/prometheus.yml
```

:::note

By default, the `resotoshell` service bind-mounts the `~/resoto-downloads` directory to `/home/resoto/downloads` in the container. This allows you to access files outputted by Resoto Shell on the host.

If you would like to change the download location from `~/resoto-downloads` to another directory, you can do so by editing the `docker-compose.yaml` file:

```yaml
resotoshell:
...
volumes:
# highlight-next-line
- ~/resoto-downloads:/home/resoto/downloads
...
```

:::

2. Start the services defined in the `docker-compose.yaml` file:

```bash
$ docker-compose pull
$ docker-compose up -d
```

Upon execution of `docker-compose up -d`, Docker Compose will start all components and set up the system. This process takes approximately 1-3 minutes, depending on your machine and internet connection.

:::note

[Docker Compose V2 integrated compose functions in to the Docker platform.](https://docs.docker.com/compose/#compose-v2-and-the-new-docker-compose-command)

In Docker Compose V2, the command is `docker compose` (no hyphen) instead of `docker-compose`.

:::

<VersionOnly allowed="current">

:::info

Resoto publishes packages for both x86 and ARM architectures for stable releases, but `edge` versions are only available for x86.

If you have an Apple Silicon or other ARM-based machine, please use the latest stable release (<LatestRelease /> or `latest`).

:::

</VersionOnly>
13 changes: 13 additions & 0 deletions docs/getting-started/install-resoto/kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,25 @@
sidebar_label: Kubernetes
pagination_prev: getting-started/install-resoto/index
pagination_next: getting-started/launch-resoto/index
unlisted: true
---

# Install Resoto with Kubernetes

[Kubernetes](https://kubernetes.io) is an open-source system for automating deployment, scaling, and management of containerized applications.

:::warning Deprecation notice

The Resoto Helm chart is no longer actively maintained. We recommend [running Resoto using Docker](./index.mdx).

:::

:::tip

Don't want to manage your own Resoto installation? Check out **[Fix](https://fix.tt)**, an all-in-one security dashboard built on top of Resoto.

:::

## Prerequisites

- [Helm](https://helm.sh) (version 3 or above)
Expand Down
13 changes: 13 additions & 0 deletions docs/getting-started/install-resoto/pip.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,25 @@
sidebar_label: pip
pagination_prev: getting-started/install-resoto/index
pagination_next: getting-started/launch-resoto/index
unlisted: true
---

# Install Resoto with pip

[pip](https://pip.pypa.io) is the package installer for [Python](https://python.org) and allows for easy installation of [Python](https://python.org) packages in Linux environments.

:::warning

Resoto consists of a number of distributed components that are intended to run 24/7 on a server. We recommend [running Resoto using Docker](./index.mdx).

:::

:::tip

Don't want to manage your own Resoto installation? Check out **[Fix](https://fix.tt)**, an all-in-one security dashboard built on top of Resoto.

:::

<VersionOnly allowed="current">

:::info
Expand Down
6 changes: 6 additions & 0 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ Resoto's documentation is organized as follows:

:::

:::tip

Don't want to manage your own Resoto installation? Check out **[Fix](https://fix.tt)**, an all-in-one security dashboard built on top of Resoto.

:::

## Why Cloud Asset Inventory?

Cloud-native infrastructure today is [fragmented](/blog/tackling-infrastructure-fragmentation-with-reactive-infrastructure) because:
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/configuration/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ $ resotoworker

The text editor opened by [Resoto Shell](../components/shell.mdx) can be configured via the `EDITOR` environment variable.

For [Docker installs](../../getting-started/install-resoto/docker.mdx), the default text editor is [nano](https://nano-editor.org).
When running Resoto in Docker, the default text editor is [nano](https://nano-editor.org).

```bash
$ export EDITOR=nano
Expand Down
Loading

0 comments on commit c748d97

Please sign in to comment.