Skip to content
Open
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ multiple USSs operating in the same general area to share information while prot
privacy. The system is focused on facilitating communication amongst actively operating USSs without details
about UAS operations stored in or processed by the DSS.

- [Deploying a DSS instance](https://interuss.github.io/dss)
- [User documentation (including deployment instructions)](https://interuss.github.io/dss)
- [Conceptual background on the DSS and services](./concepts.md)
- [Introduction to the DSS implementation](./README_DSS.md)
- [DSS implementation details](./implementation_details.md)
Expand Down
2 changes: 1 addition & 1 deletion build/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Deploying a DSS instance

This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/infrastructure/google-manual).
This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/deployment/).
2 changes: 1 addition & 1 deletion build/deploy/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Kubernetes deployment via Tanka

The documentation and configuration have been moved to the [services directory](../../deploy/services/tanka/).
Architecture, Survivability and Sizing sections have been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/architecture/)
Architecture, Survivability and Sizing sections have been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/background/architecture)

## Migrating configurations to new location

Expand Down
2 changes: 1 addition & 1 deletion deploy/MIGRATION.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# CockroachDB and Kubernetes version migration

This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/operations/migrations).
This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/operations/crdb-upgrades).
2 changes: 1 addition & 1 deletion deploy/architecture.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Kubernetes deployment

This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/architecture).
This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/background/architecture).
2 changes: 1 addition & 1 deletion deploy/infrastructure/local/minikube/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# minikube

This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/infrastructure/minikube/).
This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/deployment/infrastructure/minikube/).
4 changes: 2 additions & 2 deletions deploy/infrastructure/modules/terraform-aws-dss/DNS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Setup DNS
# terraform-aws-dss

This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/infrastructure/aws).
This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/deployment/infrastructure/aws).
2 changes: 1 addition & 1 deletion deploy/infrastructure/modules/terraform-aws-dss/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# terraform-aws-dss

This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/infrastructure/aws).
This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/deployment/infrastructure/aws).
4 changes: 2 additions & 2 deletions deploy/infrastructure/modules/terraform-google-dss/DNS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Setup DNS
# terraform-google-dss

This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/infrastructure/google).
This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/deployment/infrastructure/google).
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# terraform-google-dss

This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/infrastructure/google).
This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/deployment/infrastructure/google).
2 changes: 1 addition & 1 deletion deploy/operations/certificates-management/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Certificates management

This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/operations/certificates-management).
This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/deployment/pooling/yugabyte).
2 changes: 1 addition & 1 deletion deploy/operations/pooling-crdb.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# DSS Pooling

This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/operations/pooling-crdb).
This documentation has been moved to [interuss.github.io/dss](https://interuss.github.io/dss/dev/background/pooling-crdb).
8 changes: 4 additions & 4 deletions deploy/services/helm-charts/dss/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ This directory provides an [Helm Chart](https://helm.sh/) to deploy the DSS and

## Requirements
1. A Kubernetes cluster should be running and you should be properly authenticated. Requirements and instructions to create a new Kubernetes cluster can be found here:
* [AWS](../../../../docs/infrastructure/aws.md)
* [Google](../../../../docs/infrastructure/google.md)
* [Minikube](../../../../docs/infrastructure/minikube.md)
* [AWS](../../../../docs/deployment/infrastructure/aws.md)
* [Google](../../../../docs/deployment/infrastructure/google.md)
* [Minikube](../../../../docs/deployment/infrastructure/minikube.md)

2. Create the certificates and apply them to the cluster using the instructions [here](../../../../docs/operations/certificates-management.md)
2. Create the certificates and apply them to the cluster using the instructions [here](../../../../docs/deployment/pooling/index.md)
3. Install [Helm](https://helm.sh/) version 3.11.3 or higher

## Usage
Expand Down
8 changes: 4 additions & 4 deletions deploy/services/tanka/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ This folder contains a set of configuration to be used with [tanka](https://tank
## Requirements

1. A Kubernetes cluster should be running and you should be properly authenticated. Requirements and instructions to create a new Kubernetes cluster can be found here:
* [AWS](../../../docs/infrastructure/aws.md)
* [Google](../../../docs/infrastructure/google.md)
* [Minikube](../../../docs/infrastructure/minikube.md)
* [AWS](../../../docs/deployment/infrastructure/aws.md)
* [Google](../../../docs/deployment/infrastructure/google.md)
* [Minikube](../../../docs/deployment/infrastructure/minikube.md)

2. Create the certificates and apply them to the cluster using the instructions [here](../../../docs/operations/certificates-management.md)
2. Create the certificates and apply them to the cluster using the instructions [here](../../../docs/deployment/pooling/index.md)
3. Install [Tanka](https://tanka.dev/install)

## Usage
Expand Down
6 changes: 3 additions & 3 deletions docs/.nav.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
nav:
- "Getting Started": index.md
- "Architecture": architecture/
- "Deploy a DSS instance to": infrastructure/
- "Deploy a DSS instance": deployment/
- "Operate a DSS instance": operations/
- "Deployment checklist": deployment_checklist.md
- "Decommission a DSS instance": decommissioning/
- "Background": background/
9 changes: 9 additions & 0 deletions docs/TODO.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Remaining documentation enhancement tasks:

* Ensure deployment/pooling instructions are accurate, especially regarding the expected working directory when calling make_certs.py
* When linking to the repository, ensure repo version matches documentation version (e.g., 0.22.0 tag)
* Ensure VAR_* references outside the manual deployment instructions are defined for the terraform approach or harmonized
* In Minikube documentation, replace `dss-local-cluster` with `${cluster_name}` or similar and have users export/set that once initially
* Ensure Minikube documentation describes how to accomplish pooling
* Actually identify which tools are needed in operations/index.md rather than "some of these tools" -- the purpose of this statement is procedural to ensure ops personnel have the right tools installed, so we should identify which tools those are rather than having them guess or figure it out themselves
* Add/migrate helm documentation if that will be an officially-supported way to deploy services
4 changes: 0 additions & 4 deletions docs/architecture/.nav.yml

This file was deleted.

33 changes: 0 additions & 33 deletions docs/assets/create_pool_2.puml

This file was deleted.

55 changes: 0 additions & 55 deletions docs/assets/create_pool_n.gv

This file was deleted.

11 changes: 0 additions & 11 deletions docs/assets/deployment_layers.gv

This file was deleted.

Binary file removed docs/assets/generated/create_pool_2.png
Binary file not shown.
Binary file removed docs/assets/generated/create_pool_n.png
Binary file not shown.
Binary file removed docs/assets/generated/deployment_layers.png
Binary file not shown.
8 changes: 8 additions & 0 deletions docs/background/.nav.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
nav:
- "Overview": index.md
- "Architecture": architecture.md
- "Authentication": authentication.md
- "Sizing": sizing.md
- "Pooling": pooling.md
- "Pooling: YugabyteDB specifics": pooling-yugabyte.md
- "Pooling: CRDB specifics": pooling-crdb.md
16 changes: 1 addition & 15 deletions docs/architecture/index.md → docs/background/architecture.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Architecture
# Deployment architecture

## Introduction

Expand Down Expand Up @@ -30,20 +30,6 @@ Top level simplified view, with one replica shown and yugabyte services regroupe
To reduce the number of required public load balancers, we do use an intermediate reverse proxy to expose the ports of Yugabyte master and tserver on a shared public IP per stateful set instance.
Usual Kubernetes load balancers can't assign connection based on ports out of the box, so we use the reverse proxy to dispatch connections on both services depending on the connected port.

### Terminology notes

See [teminology notes](../operations/pooling.md#terminology-notes).

## Pooling

### Objective

See [Pooling Objective](../operations/pooling.md#objective) and subsections.

### Additional requirements

See [Additional requirements](../operations/pooling.md#additional-requirements).

### Survivability

One of the primary design considerations of the DSS is to be very resilient to
Expand Down
File renamed without changes.
10 changes: 10 additions & 0 deletions docs/background/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Background overview

Background information on various aspects of the InterUSS DSS product may be found here.

* [Architecture](./architecture.md)
* [Authentication](./authentication.md)
* [Sizing](./sizing.md)
* [Pooling](./pooling.md)
* [With CockroachDB](./pooling-crdb.md)
* [With YugabyteDB](./pooling-yugabyte.md)
Loading
Loading