Skip to content
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions REBRANDING-PLAN.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,9 +319,9 @@ Directory: `docs/overview/design/arch-decision-records/`
| ------------------------------------------------------------ | --------------------------- |
| `https://github.com/NASA-AMMOS/aerie` | Update to new repo or keep? |
| `https://github.com/NASA-AMMOS/aerie-docs` | Update to new repo |
| `https://github.com/NASA-AMMOS/aerie-ui` | Update to new repo |
| `https://github.com/NASA-AMMOS/aerie-mission-model-template` | Update to new repo |
| `https://github.com/NASA-AMMOS/aerie-gateway` | Update to new repo |
| `https://github.com/NASA-AMMOS/plandev-ui` | Update to new repo |
| `https://github.com/NASA-AMMOS/plandev-mission-model-template` | Update to new repo |
| `https://github.com/NASA-AMMOS/plandev-gateway` | Update to new repo |

### 8.2 Email Addresses

Expand All @@ -340,7 +340,7 @@ Directory: `docs/overview/design/arch-decision-records/`

| Current | New |
| ------------------------------------------ | --- |
| `https://nasa-ammos.github.io/aerie-docs/` | TBD |
| `https://nasa-ammos.github.io/plandev-docs/` | TBD |

---

Expand Down
6 changes: 3 additions & 3 deletions docs/api/examples/external-events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
Refer to [External Events](../../../planning/external-events/introduction) for more information on External Events & Sources.

## API Gateway
External Events & their respective External Sources utilize routes located on [`aerie-gateway`](https://github.com/NASA-AMMOS/aerie-gateway) to perform data validation and upon success, an upload through Hasura/GQL.
External Events & their respective External Sources utilize routes located on [`plandev-gateway`](https://github.com/NASA-AMMOS/plandev-gateway) to perform data validation and upon success, an upload through Hasura/GQL.


### Creating External Source & Event Types
To upload schemas for External Sources and Events, users should POST to the `/uploadExternalSourceEventTypes` route in `aerie-gateway`.
To upload schemas for External Sources and Events, users should POST to the `/uploadExternalSourceEventTypes` route in `plandev-gateway`.

The body of the request should be a JSON object with this structure:

Expand Down Expand Up @@ -51,7 +51,7 @@ This endpoint expects data provided in [`multipart/form-data` format](https://ww



When uploading through PlanDev's UI, the External Source & it's contained External Events are packaged together in a single `JSON` file which adheres to the meta-schema defined [here](https://github.com/NASA-AMMOS/aerie-gateway/blob/develop/src/schemas/external-event-validation-schemata.ts). A `derivation_group_name` can be passed in as an argument with the request which will override any value for `derivation_group_name` in the External Source. This argument can be ignored if there is a value for `derivation_group_name` in the External Source.
When uploading through PlanDev's UI, the External Source & it's contained External Events are packaged together in a single `JSON` file which adheres to the meta-schema defined [here](https://github.com/NASA-AMMOS/plandev-gateway/blob/develop/src/schemas/external-event-validation-schemata.ts). A `derivation_group_name` can be passed in as an argument with the request which will override any value for `derivation_group_name` in the External Source. This argument can be ignored if there is a value for `derivation_group_name` in the External Source.

:::info Note

Expand Down
6 changes: 3 additions & 3 deletions docs/command-expansion/sequences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ We are exploring several options to mitigate the rework.

:::

This page will pick up after the third step.
This page will pick up after the third step.

To create a filter, select the following:

Expand All @@ -45,7 +45,7 @@ To create a filter, select the following:
<figcaption>Figure 2: Sequence Filter Creation </figcaption>
</figure>

name it, and then select all relevant options to narrow down the set of simulated activities that you would like to associate with the sequence you will be creating.
name it, and then select all relevant options to narrow down the set of simulated activities that you would like to associate with the sequence you will be creating.

<figure>
<img alt="PlanDev UI - Sequence Filter Options" src={planExpansionFilterFinish} />
Expand Down Expand Up @@ -83,6 +83,6 @@ PlanDev recommends automating the seqID declaration and seqID-activity associati

## Command Sorting

As of PlanDev [v1.5.0](https://github.com/NASA-AMMOS/aerie/releases/tag/v1.5.0), during expansion if more than one activity targets a single sequence then the commands are sorted time-ascending if all commands use either absolute or relative time tags, and the first command for each activity uses an absolute time tag. Otherwise none of the commands are sorted. If the commands are sorted then all time tags are converted to absolute time.
As of PlanDev [v1.5.0](https://github.com/NASA-AMMOS/plandev/releases/tag/v1.5.0), during expansion if more than one activity targets a single sequence then the commands are sorted time-ascending if all commands use either absolute or relative time tags, and the first command for each activity uses an absolute time tag. Otherwise none of the commands are sorted. If the commands are sorted then all time tags are converted to absolute time.

Additionally a `timeSorted` boolean property has been added to the expanded sequence `metadata` indicating if the commands have been sorted (true for sorted, false otherwise).
2 changes: 1 addition & 1 deletion docs/deployment/advanced-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To learn how to programmatically authenticate with PlanDev to get a token, see t

## Service Environment Variables

The default PlanDev [docker-compose.yml](https://github.com/NASA-AMMOS/aerie/blob/develop/deployment/docker-compose.yml) file requires certain environment variables to be set to enable authentication. This section outlines the variable definitions and the services that require them for authentication.
The default PlanDev [docker-compose.yml](https://github.com/NASA-AMMOS/plandev/blob/develop/deployment/docker-compose.yml) file requires certain environment variables to be set to enable authentication. This section outlines the variable definitions and the services that require them for authentication.

### AUTH_GROUP_ROLE_MAPPINGS
- Description: Optional JSON object that maps LDAP groups to allowed PlanDev roles.
Expand Down
6 changes: 3 additions & 3 deletions docs/deployment/advanced-database-migrations-OLD.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ For PlanDev deployments AFTER to v3.3.0, please reference [this page](../advance
for accurate information as to how the migration script works.
:::

To aid in migrating between database versions we provide a Python script called [aerie_db_migration.py](https://github.com/NASA-AMMOS/aerie/blob/develop/deployment/aerie_db_migration). In order to run it, the following software is required:
To aid in migrating between database versions we provide a Python script called [aerie_db_migration.py](https://github.com/NASA-AMMOS/plandev/blob/develop/deployment/aerie_db_migration). In order to run it, the following software is required:

- [Python 3.9](https://www.python.org/downloads/) or later
- [Hasura CLI 2.35.1](https://hasura.io/docs/latest/hasura-cli/install-hasura-cli/) or later

Additional Python package requirements can be installed by running the following command in the [deployment](https://github.com/NASA-AMMOS/aerie/tree/develop/deployment) directory:
Additional Python package requirements can be installed by running the following command in the [deployment](https://github.com/NASA-AMMOS/plandev/tree/develop/deployment) directory:

```sh
python -m pip install -r requirements.txt
```

Once the prerequisite software has been installed, the script can be executed by running the following command from inside the PlanDev [deployment](https://github.com/NASA-AMMOS/aerie/tree/develop/deployment) directory:
Once the prerequisite software has been installed, the script can be executed by running the following command from inside the PlanDev [deployment](https://github.com/NASA-AMMOS/plandev/tree/develop/deployment) directory:

```sh
python aerie_db_migration.py
Expand Down
6 changes: 3 additions & 3 deletions docs/deployment/advanced-database-migrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ For PlanDev deployments PRIOR to v3.3.0, please reference [this page](../advance
for accurate information as to how the migration script works.
:::

To aid in migrating between database versions we provide a Python script called [aerie_db_migration.py](https://github.com/NASA-AMMOS/aerie/blob/develop/deployment/aerie_db_migration). In order to run it, the following software is required:
To aid in migrating between database versions we provide a Python script called [aerie_db_migration.py](https://github.com/NASA-AMMOS/plandev/blob/develop/deployment/aerie_db_migration). In order to run it, the following software is required:

- [Python 3.9](https://www.python.org/downloads/) or later
- [Hasura CLI 2.35.1](https://hasura.io/docs/latest/hasura-cli/install-hasura-cli/) or later

Additional Python package requirements can be installed by running the following command in the [deployment](https://github.com/NASA-AMMOS/aerie/tree/develop/deployment) directory:
Additional Python package requirements can be installed by running the following command in the [deployment](https://github.com/NASA-AMMOS/plandev/tree/develop/deployment) directory:

```sh
python -m pip install -r requirements.txt
```

Once the prerequisite software has been installed, the script can be executed by running the following command from inside the PlanDev [deployment](https://github.com/NASA-AMMOS/aerie/tree/develop/deployment) directory:
Once the prerequisite software has been installed, the script can be executed by running the following command from inside the PlanDev [deployment](https://github.com/NASA-AMMOS/plandev/tree/develop/deployment) directory:

```sh
python aerie_db_migration.py <SUBCOMMAND>
Expand Down
2 changes: 1 addition & 1 deletion docs/deployment/advanced-kubernetes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ kubectl set image deployment/aerie-ui-deployment aerie-ui=ghcr.io/nasa-ammos/aer

## Within PlanDev context

PlanDev is provided as a set of container images, which makes it a perfect match for a Kubernetes deployment. Manifests for PlanDev on Kubernetes are provided in the [PlanDev repo](https://github.com/NASA-AMMOS/aerie/tree/develop/deployment/kubernetes). These manifests create `Deployments` for each of the PlanDev services, e.g. `aerie-merlin`, `hasura`, etc. with one replica of each `Pod`. An existing Kubernetes cluster will be needed. See one of the following sections for instructions on spinning up a cluster varying environments.
PlanDev is provided as a set of container images, which makes it a perfect match for a Kubernetes deployment. Manifests for PlanDev on Kubernetes are provided in the [PlanDev repo](https://github.com/NASA-AMMOS/plandev/tree/develop/deployment/kubernetes). These manifests create `Deployments` for each of the PlanDev services, e.g. `aerie-merlin`, `hasura`, etc. with one replica of each `Pod`. An existing Kubernetes cluster will be needed. See one of the following sections for instructions on spinning up a cluster varying environments.

## Local Kubernetes deployment

Expand Down
4 changes: 2 additions & 2 deletions docs/deployment/advanced-permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ it is strongly recommended to give your role *at least* the same permissions as

### Adding the Role to Hasura

In order to interact with the PlanDev system, a role must first be provided access via the [Hasura Metadata](https://github.com/NASA-AMMOS/aerie/tree/develop/deployment/hasura/metadata).
In order to interact with the PlanDev system, a role must first be provided access via the [Hasura Metadata](https://github.com/NASA-AMMOS/plandev/tree/develop/deployment/hasura/metadata).

There are three parts of the Hasura Metadata that a role needs to be added to:
Functions, Actions, and individual tables. The Hasura Metadata can be found in `hasura/metadata`.
Expand Down Expand Up @@ -362,7 +362,7 @@ By default, users will use the `user` role and have access to the `user` and `vi
To configure this, use the `ALLOWED_ROLES` and `DEFAULT_ROLE` environment variables.
**Note: `DEFAULT_ROLE` _must_ be an entry in `ALLOWED_ROLES`.**

For more information, see the [Environment Variables document](https://github.com/NASA-AMMOS/aerie-gateway/blob/develop/docs/ENVIRONMENT.md) in the Gateway.
For more information, see the [Environment Variables document](https://github.com/NASA-AMMOS/plandev-gateway/blob/develop/docs/ENVIRONMENT.md) in the Gateway.

:::info When Authentication is Disabled
[If authentication is disabled](../advanced-authentication/), then the following changes apply:
Expand Down
14 changes: 7 additions & 7 deletions docs/deployment/advanced-ui-custom-base-path.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ This document lists the instructions for building an aerie-ui Docker image with

### Building

1. Clone the [aerie-ui](https://github.com/NASA-AMMOS/aerie-ui) and install dependencies. Note that [Node LTS](https://nodejs.org/) is required (currently 18.13.0).
1. Clone the [aerie-ui](https://github.com/NASA-AMMOS/plandev-ui) and install dependencies. Note that [Node LTS](https://nodejs.org/) is required (currently 18.13.0).

```sh
git clone https://github.com/NASA-AMMOS/aerie-ui.git
git clone https://github.com/NASA-AMMOS/plandev-ui.git
cd aerie-ui
npm install
```

When you clone aerie-ui the default branch is [develop](https://github.com/NASA-AMMOS/aerie-ui/tree/develop). If you want to build an image from a [specific release](https://github.com/NASA-AMMOS/aerie-ui/releases) you have to checkout the proper tag. For example to checkout [v1.0.0](https://github.com/NASA-AMMOS/aerie-ui/releases/tag/v1.0.0) do:
When you clone aerie-ui the default branch is [develop](https://github.com/NASA-AMMOS/plandev-ui/tree/develop). If you want to build an image from a [specific release](https://github.com/NASA-AMMOS/plandev-ui/releases) you have to checkout the proper tag. For example to checkout [v1.0.0](https://github.com/NASA-AMMOS/plandev-ui/releases/tag/v1.0.0) do:

```sh
git checkout tags/v1.0.0 -b v1.0.0
```

2. Update [svelte.config.js](https://github.com/NASA-AMMOS/aerie-ui/blob/develop/svelte.config.js) with the [base path](https://github.com/NASA-AMMOS/aerie-ui/blob/develop/svelte.config.js#L9) you want to use. Note that a leading `/` is required. So for example a valid base path is `/aerie`.
2. Update [svelte.config.js](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/svelte.config.js) with the [base path](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/svelte.config.js#L9) you want to use. Note that a leading `/` is required. So for example a valid base path is `/aerie`.

3. Build the aerie-ui.

Expand All @@ -32,7 +32,7 @@ This document lists the instructions for building an aerie-ui Docker image with
docker build -t aerie-ui .
```

5. Use the newly built image as part of your normal [PlanDev Docker deployment](https://github.com/NASA-AMMOS/aerie/blob/develop/deployment/docker-compose.yml#L132).
5. Use the newly built image as part of your normal [PlanDev Docker deployment](https://github.com/NASA-AMMOS/plandev/blob/develop/deployment/docker-compose.yml#L132).

### Cleaning

Expand All @@ -52,8 +52,8 @@ docker rmi aerie-ui

### References

1. [aerie-ui Developer.md](https://github.com/NASA-AMMOS/aerie-ui/blob/develop/docs/DEVELOPER.md)
1. [aerie-ui Deployment.md](https://github.com/NASA-AMMOS/aerie-ui/blob/develop/docs/DEPLOYMENT.md)
1. [aerie-ui Developer.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEVELOPER.md)
1. [aerie-ui Deployment.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEPLOYMENT.md)

### Svelte Kit Issues

Expand Down
10 changes: 5 additions & 5 deletions docs/deployment/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,19 +4,19 @@ There are a few different ways to deploy PlanDev:

- To get PlanDev running **quickly** on your computer, see the [fast track instructions](/introduction/#fast-track) for minimal setup.
- If you plan to deploy PlanDev in a shared **production environment**, read this entire page and then see the [production deployment guide](/deployment/production-deployment).
- If you are a **developer** and you want to run PlanDev locally & make changes to PlanDev core code, read this page and then head to the [developer guide](https://github.com/NASA-AMMOS/aerie/blob/develop/docs/DEVELOPER.md) in the repository for local setup instructions.
- If you are a **developer** and you want to run PlanDev locally & make changes to PlanDev core code, read this page and then head to the [developer guide](https://github.com/NASA-AMMOS/plandev/blob/develop/docs/DEVELOPER.md) in the repository for local setup instructions.

The rest of this document goes into more depth about the PlanDev system and how it should be deployed, regardless of environment.

## PlanDev Releases

PlanDev releases are published on the [Github Releases page](https://github.com/NASA-AMMOS/aerie/releases), and each release has a `Deployment.zip` artifact attached. This folder contains everything necessary to deploy a version of PlanDev - namely the **`docker-compose.yml`** and **`.env`** files, detailed below. These files are provided _as a starting point_ and should be modified to suit your needs.
PlanDev releases are published on the [Github Releases page](https://github.com/NASA-AMMOS/plandev/releases), and each release has a `Deployment.zip` artifact attached. This folder contains everything necessary to deploy a version of PlanDev - namely the **`docker-compose.yml`** and **`.env`** files, detailed below. These files are provided _as a starting point_ and should be modified to suit your needs.

## Environment Variables

Each PlanDev service is configured with environment variables, some of which are **required** to run. They are expected to be set in a `.env` file in the folder you're running PlanDev from. The version of this file provided in `Deployment.zip` is an empty template that must be filled in with service usernames and passwords of your choosing. See [this .env.template file](https://github.com/NASA-AMMOS/aerie-mission-model-template/blob/main/.env.template) for a completed example.
Each PlanDev service is configured with environment variables, some of which are **required** to run. They are expected to be set in a `.env` file in the folder you're running PlanDev from. The version of this file provided in `Deployment.zip` is an empty template that must be filled in with service usernames and passwords of your choosing. See [this .env.template file](https://github.com/NASA-AMMOS/plandev-mission-model-template/blob/main/.env.template) for a completed example.

A description of allowed variables is found in the [Environment Variable Documentation](https://github.com/NASA-AMMOS/aerie/blob/develop/deployment/Environment.md) - it's recommended to read through these & determine which are relevant to your situation.
A description of allowed variables is found in the [Environment Variable Documentation](https://github.com/NASA-AMMOS/plandev/blob/develop/deployment/Environment.md) - it's recommended to read through these & determine which are relevant to your situation.

Of note, the `aerie-merlin`, `aerie_merlin_worker`, `aerie-scheduler`, and `aerie-scheduler-worker` containers can be provided additional JVM arguments - for example, allocated heap size - as environment variables. Desired JVM flags should be added to the `JAVA_OPTS` environment variable for the container being configured.

Expand Down Expand Up @@ -87,7 +87,7 @@ Defect reports should be sent to: `plandev-support@googlegroups.com`. For chat-b
[gateway]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-gateway
[hasura]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-hasura
[merlin]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-merlin
[merlin-worker]: https://github.com/NASA-AMMOS/aerie/pkgs/container/aerie-merlin-worker
[merlin-worker]: https://github.com/NASA-AMMOS/plandev/pkgs/container/aerie-merlin-worker
[postgres]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-postgres
[scheduler]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-scheduler
[scheduler-worker]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-scheduler-worker
Expand Down
Loading
Loading