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

Update GRR docs #171

Merged
merged 3 commits into from
Apr 24, 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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@ clients separately.
Google Compute Engine (GCE) of course :) We’re working on making cloud
deployment easier by dockerizing and building a click-to-deploy for GCE.
Our focus will be primarily on making this work on GCE, but moving to a
docker deployment with orchestration will simplify deployment on all
Docker deployment with orchestration will simplify deployment on all
clouds. The largest cloud deployments of GRR are currently on EC2, and
we hope the community will be able to share configuration and HOWTOs for
this and other cloud deployments.
Expand Down
13 changes: 0 additions & 13 deletions fleetspeak/from-release-deb.md

This file was deleted.

197 changes: 0 additions & 197 deletions fleetspeak/from-source.md

This file was deleted.

11 changes: 0 additions & 11 deletions fleetspeak/index.md

This file was deleted.

Binary file added images/grr_components.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ maxdepth: 2
---
What is GRR? <what-is-grr.md>
Quickstart <quickstart.md>
Installing GRR server <installing-grr-server/index.md>
Installing and Running GRR <installing-and-running-grr/index.md>
Deploying GRR clients <deploying-grr-clients/index.md>
Investigating with GRR <investigating-with-grr/index.md>
Maintaining and tuning GRR deployment <maintaining-and-tuning/index.md>
Expand Down
9 changes: 9 additions & 0 deletions installing-and-running-grr/advanced-usecases/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Advanced Usecases

```{toctree}
---
maxdepth: 1
---
Scaling a fleetspeak setup <scaling.md>
Running GRR and Fleetspeak with Envoy <sandbox.md>
```
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The following diagram shows the high level architecture of the sandbox environment.

![sandbox fleetspeak](../images/sandbox_fleetspeak.png)
![sandbox fleetspeak](../../images/sandbox_fleetspeak.png)

This sandbox uses [Docker Compose](https://docs.docker.com/compose/) to demonstrate how to run [GRR](https://github.com/google/grr) and [Fleetspeak](https://github.com/google/fleetspeak) with [Envoy](https://www.envoyproxy.io/) leveraging Fleetspeak in the HTTPS header frontend mode.
This frontend mode lends itself to showcase an example of Fleetspeak's more involved frontend modes.
Expand All @@ -14,44 +14,21 @@ Before you begin you will need to setup the sandbox environment.
It is important that you follow all the steps in the [setup instructions](#setup-instructions) section before running the sandbox.

## Setup the sandbox environment
- [Install Docker](#install-docker)
- [Install docker compose](#install-docker-compose)
- [Install Git](#install-git)
- [Follow the "Install * " instructions for GRR](../../installing-and-running-grr/via-docker-compose.md)
- [Clone the GRR Doc repository](#clone-the-grr-doc-repository)
- [Create Configurations](#create-configurations)

### Install docker
Ensure that you have a recent versions of ```docker``` installed.

You will need a minimum version of ```19.03.0+```.

Version ```20.10``` is well tested, and has the benefit of included ```compose```.

The user account running the examples will need to have permission to use Docker on your system.

Full instructions for installing Docker can be found on the [Docker website](https://docs.docker.com/get-docker/).

### Install docker compose
The examples use [Docker compose configuration version 3.8](https://docs.docker.com/compose/compose-file/compose-versioning/#version-38).

You will need to a fairly recent version of [Docker Compose](https://docs.docker.com/compose/).

### Install Git
The GRR Doc repository is managed using [Git](https://git-scm.com/).

You can [find instructions for installing Git on various operating systems here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git).

### Clone the GRR Doc repository
If you have not cloned the GRR Doc repository already, clone it with:

```
git clone https://github.com/google/grr-doc
git clone https://github.com/google/grr
```

### Create configurations

```
cd grr-doc/fleetspeak/sandbox
cd grr-doc/installing-and-running-grr/advanced-usecases/sandbox
./createConfig.sh
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The following diagram shows a standard, distributed fleetspeak setup:

<!-- https://docs.google.com/drawings/d/1BwQhwu5phznyvYd3ydUu7lIPX-NVutmTny77-jkp8u0/edit -->

![distributed fleetspeak](../images/distributed_fleetspeak.png)
![distributed fleetspeak](../../images/distributed_fleetspeak.png)

The fleetspeak server setup consists of 2 components:

Expand Down