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
2 changes: 1 addition & 1 deletion docs/api/examples/external-events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Uploading a definition of a single External Source Type (`ExampleSource`) and a
```

### Creating an External Source
To upload External Sources, users should POST to the `/uploadExternalSource` route in `aerie-gateway`.
To upload External Sources, users should POST to the `/uploadExternalSource` route in `plandev-gateway`.

This endpoint expects data provided in [`multipart/form-data` format](https://www.ietf.org/rfc/rfc2388.txt).

Expand Down
10 changes: 5 additions & 5 deletions docs/api/introduction.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,7 @@ Set it to the following:
{
"headers": {
"x-hasura-admin-secret": "<YOUR_ADMIN_SECRET>",
"x-hasura-user-id": "<YOUR_AERIE_USERNAME>",
"x-hasura-user-id": "<YOUR_PLANDEV_USERNAME>",
"x-hasura-role": "viewer"
}
}
Expand Down Expand Up @@ -188,7 +188,7 @@ const res = await altair.helpers.request(
'POST',
'/auth/login', // AUTH ENDPOINT OF THE DEPLOYMENT
{
body: { username: '<YOUR_AERIE_USERNAME>', password: '<YOUR_AERIE_PASSWORD>' }, // CREDENTIALS TO LOG IN AS
body: { username: '<YOUR_PLANDEV_USERNAME>', password: '<YOUR_PLANDEV_PASSWORD>' }, // CREDENTIALS TO LOG IN AS
headers: { 'Content-Type': 'application/json' },
},
);
Expand Down Expand Up @@ -222,13 +222,13 @@ const res = await altair.helpers.request(
'POST',
'/auth/login', // AUTH ENDPOINT OF THE DEPLOYMENT
{
body: { username: '<YOUR_AERIE_USERNAME>', password: '<YOUR_AERIE_PASSWORD>' }, // CREDENTIALS TO LOG IN AS
body: { username: '<YOUR_PLANDEV_USERNAME>', password: '<YOUR_PLANDEV_PASSWORD>' }, // CREDENTIALS TO LOG IN AS
headers: { 'Content-Type': 'application/json' },
},
);
```

Replace `<YOUR_AERIE_USERNAME>` and `<YOUR_AERIE_PASSWORD>` with the username and password you use to sign in to PlanDev.
Replace `<YOUR_PLANDEV_USERNAME>` and `<YOUR_PLANDEV_PASSWORD>` with the username and password you use to sign in to PlanDev.

:::info Setting Your Role
By default, you will make queries using the `viewer` role. If you want to use a different role,
Expand Down Expand Up @@ -258,7 +258,7 @@ import json
import os
import requests

token = os.getenv('AERIE_TOKEN')
token = os.getenv('PLANDEV_TOKEN')

response = requests.post(
url='http://localhost:8080/v1/graphql', # Change from 'localhost' as needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ Unflattened: 1,2,3.5,string; Flattened: [1 2 3.5 string]

---

Putting this all together in AERIE, we might have the following:
Putting this all together in Plandev, we might have the following:

<figure>
<img alt="PlanDev UI - Template With Helpers" src={templateHelpers} />
Expand Down
8 changes: 4 additions & 4 deletions docs/command-expansion/template-expansion/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,17 @@ C DP_PRIORITIZE "STRING" 5
```

## Configuration
In order to use sequence templates instead of the existing Typescript EDSL sequence expansion rules, you need to make a configuration change to your `aerie-ui` container.
In order to use sequence templates instead of the existing Typescript EDSL sequence expansion rules, you need to make a configuration change to the Plandev UI service.

:::caution
Sequence templating and EDSL rules are exclusive of each other. They cannot coexist in the same instance of PlanDev.
:::

If you are running `aerie-ui` locally, then within the `aerie-ui` directory, navigate to `{aerie-ui path}/.env` and update the variable `PUBLIC_COMMAND_EXPANSION_MODE` to `templating`, instead of its default (`legacy`). Then restart the server process.
If you are running `plandev-ui` locally from the git repository, then within the `plandev-ui` directory, navigate to `{plandev-ui path}/.env` and update the variable `PUBLIC_COMMAND_EXPANSION_MODE` to `templating`, instead of its default (`legacy`). Then restart the server process.

If you are running `aerie` in docker, then within the `aerie` directory, navigate to `{aerie path}/docker-compose.yml`, and update the variable `PUBLIC_COMMAND_EXPANSION_MODE` under the `aerie-ui` container's settings to `templating`, instead of its default (`legacy`). Then, redeploy the container.
If you are running PlanDev Docker services, then open the `docker-compose.yml` file you are using and update the `PUBLIC_COMMAND_EXPANSION_MODE` under the `aerie-ui` container's settings to `templating`, instead of its default (`legacy`). Then, redeploy the container.

If you are accessing `aerie` remotely via an externally managed host, please reach out to that system's administrator about changing the deployment configuration.
If you are accessing PlanDev remotely via an externally managed host, please reach out to that system's administrator about changing the deployment configuration.

## Sequence Templates in PlanDev
After having enabled sequence templates, you are ready to author your own templates and expand with them. Prior to doing so, however, it might be instructive to provide a brief discussion of what these templates require and how they differ from Typescript expansion rules:
Expand Down
16 changes: 8 additions & 8 deletions docs/deployment/advanced-ui-custom-base-path.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
# Advanced - UI Custom Base Path

This document lists the instructions for building an aerie-ui Docker image with a [custom base path](https://kit.svelte.dev/docs/configuration#paths). While the default path and resulting application URL are usually a good fit, some installations may choose a custom path to support deployment behind a gateway, to provide consistency with other non-PlanDev applications that the mission is using, or this could be part of a configuration that supports running multiple instances of PlanDev UI on the same machine.
This document lists the instructions for building a PlanDev UI docker image with a [custom base path](https://kit.svelte.dev/docs/configuration#paths). While the default path and resulting application URL are usually a good fit, some installations may choose a custom path to support deployment behind a gateway, to provide consistency with other non-PlanDev applications that the mission is using, or this could be part of a configuration that supports running multiple instances of PlanDev UI on the same machine.

### Building

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).
1. Clone the [plandev-ui](https://github.com/NASA-AMMOS/plandev-ui) repository and install dependencies. Note that [Node LTS](https://nodejs.org/) is required (currently 18.13.0).

```sh
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/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:
When you clone plandev-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/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`.
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 `/plandev`.

3. Build the aerie-ui.
3. Build the plandev-ui.

```sh
npm run build
```

4. Build the aerie-ui Docker image. Change the tag as necessary. For example we tag the image here with `aerie-ui`:
4. Build the UI Docker image. By convention, docker images/containers use the legacy "aerie" name. For example we tag the image here with `aerie-ui`, but you can change this tag:

```sh
docker build -t aerie-ui .
Expand All @@ -52,8 +52,8 @@ docker rmi aerie-ui

### References

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)
1. [plandev-ui Developer.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEVELOPER.md)
1. [plandev-ui Deployment.md](https://github.com/NASA-AMMOS/plandev-ui/blob/develop/docs/DEPLOYMENT.md)

### Svelte Kit Issues

Expand Down
4 changes: 3 additions & 1 deletion docs/deployment/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ The following is a list of all of the required PlanDev services, their associate
| [aerie-scheduler-worker][scheduler-worker] | Worker for executing scheduling goals | 27189 | ❌ |
| [aerie-sequencing][sequencing] | Service for sequence generation and management | 27184 | ❌ |

By convention, these containers use our legacy `aerie-` naming scheme, & will be renamed to `plandev-` in a future update

## System Requirements

### Software
Expand Down Expand Up @@ -82,7 +84,7 @@ Note these numbers are lower bounds. You will need to scale PlanDev based on you

## Defect Reporting Procedure

Defect reports should be sent to: `plandev-support@googlegroups.com`. For chat-based support, please join us on the [NASA-AMMOS Slack](https://join.slack.com/t/nasa-ammos/shared_invite/zt-1mlgmk5c2-MgqVSyKzVRUWrXy87FNqPw), in the `#aerie-users` channel.
Defect reports should be sent to: `plandev-support@googlegroups.com`. For chat-based support, please join us on the [NASA-AMMOS Slack](https://join.slack.com/t/nasa-ammos/shared_invite/zt-1mlgmk5c2-MgqVSyKzVRUWrXy87FNqPw), in the `#plandev-users` channel.

[gateway]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-gateway
[hasura]: https://github.com/orgs/NASA-AMMOS/packages/container/package/aerie-hasura
Expand Down
14 changes: 0 additions & 14 deletions docs/overview/aerie-renamed-to-plandev.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/overview/design/software-design-document.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -535,7 +535,7 @@ configuration file.

PlanDev provides authentication and authorization capabilities via the
Common Access Manager. Currently, authentication requests from the
PlanDev UI are proxied through the aerie-ui-server. It is prudent that
PlanDev UI are proxied through the aerie-ui service. It is prudent that
PlanDev not handle (proxy/store) any credential information, for any
duration of time. As a result, PlanDev authentication will soon be
amended so requests for an authentication token are made directly to a
Expand Down
12 changes: 12 additions & 0 deletions docs/overview/plandev-seqdev-naming.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
## PlanDev & SeqDev Naming

As new mission communities have joined PlanDev, we've evolved our product focus and naming. What you need to know:

What to know:

* The planning tool is now named **PlanDev** and the sequencing tool is now named **SeqDev**
* Most repositories have been renamed, and the rest will be renamed soon. The repository code structure has not changed
* Published code packages (NPM, Java, and Docker images) still retain their **old** names but will be renamed in a future version
* Changes affecting your code will be announced in advance with upgrade guidance

You are already on our updated docs page, which is https://nasa-ammos.github.io/plandev-docs/. Links to pages in the old docs site will be redirected to their new equivalent, but it is a good idea to update any links in your documents when possible.
4 changes: 2 additions & 2 deletions docs/planning/advanced-incons.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ The most important element of this JSON is `filename`. It contains the name of t

### Step 3: Use the Incons in Simulation

Finally, open the Simulation Configuration panel and set the `inconsPath` argument to `<path-to-aerie-file-store>/<filename>`,
where `<path-to-aerie-file-store>` is the path to where the `aerie_file_store` volume is mounted in Merlin,
Finally, open the Simulation Configuration panel and set the `inconsPath` argument to `<path-to-file-store>/<filename>`,
where `<path-to-file-store>` is the path to where the `aerie_file_store` volume is mounted in Merlin,
and `<filename>` is the value of `"filename"` from the earlier JSON from the Gateway.

By default, `<path-to-aerie-file-store>` is `merlin_file_store`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -176,7 +176,7 @@ public record ExternalEventsSourceQueryGoal() implements Goal {
}
```

After running it, we get the following result in AERIE:
After running it, we get the following result in PlanDev:

import results from './assets/results.png';

Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade-guides/3-8-1-to-4-0-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ What to know:
* The sequencing product, including the sequence editor, workspaces, and actions, is now named **SeqDev**.
* All features and functionality remain the same.
* As of v4.0.0, repository names, package names and other internal code references will retain their existing names, and deployment/migration procedures have not changed.
* In a future release, repository and/or package names may change. If so, this will be communicated to users via release notes and normal communication channels. Latest updates can be found on [the "Rename" page](/overview/aerie-renamed-to-plandev/) in the docs.
* In a future release, repository and/or package names may change. If so, this will be communicated to users via release notes and normal communication channels. Latest updates can be found on [the "Naming" page](/overview/plandev-seqdev-naming/) in the docs.

You are already on our new docs page, which is https://nasa-ammos.github.io/plandev-docs/. Links to pages in the old Aerie docs will be redirected to their new PlanDev equivalent, but it is a good idea to update any links in your documents when possible.

Expand Down
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ const sidebars = {
'overview/design/software-design-document',
],
},
'overview/aerie-renamed-to-plandev',
'overview/plandev-seqdev-naming',
],
},
{
Expand Down
Loading