Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
Lauren Frederick committed Nov 13, 2018
1 parent 4f2ee63 commit eac2a6a
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 12 deletions.
2 changes: 2 additions & 0 deletions README.md
Expand Up @@ -17,6 +17,8 @@ For more information about this project of more about NASA's Earth Observing Sys

## Installation

This is for installation for Cumulus development. See the [Cumulus deployment instructions](https://nasa.github.io/cumulus/docs/deployment/deployment-readme) for instructions on deploying the released Cumulus packages.

### Prerequisites

* [NVM](https://github.com/creationix/nvm) and node version 8.
Expand Down
6 changes: 3 additions & 3 deletions docs/data-cookbooks/cnm-workflow.md
Expand Up @@ -131,7 +131,7 @@ CNMExampleWorkflow:
- ErrorEquals:
- States.ALL
ResultPath: '$.exception'
Next: CmrResponse
Next: CnmResponse
Next: CnmResponse
CnmResponse:
CumulusConfig:
Expand Down Expand Up @@ -219,7 +219,7 @@ CnmResponse:
runtime: java8
memory: 256
s3Source:
bucket: 'cumulus-data-shared''
bucket: 'cumulus-data-shared'
key: 'daacs/podaac/cnmResponse-1.0.zip'
launchInVpc: true
```
Expand Down Expand Up @@ -260,7 +260,7 @@ To add a rule via the dashboard (if you'd like to use the API, see the docs [her
"value": "arn:aws:kinesis:{{awsRegion}}:{{awsAccountId}}:stream/{{streamName}}"
},
"state": "ENABLED",
"workflow": "KinesisTriggerTest"
"workflow": "CNMExampleWorkflow"
}
```

Expand Down
2 changes: 1 addition & 1 deletion docs/data-cookbooks/error-handling.md
Expand Up @@ -27,7 +27,7 @@ Some best practices for error handling in Cumulus Workflows are:
Note: In the example below, YAML syntax (i.e. `&ErrorEqualDefaults` and `<<: *ErrorEqualDefaults`) is used to create references to reusable blocks which makes the definition less repetitive. Read more here: [YAML - Anchors, References, Extend](https://blog.daemonl.com/2016/02/yaml.html).

```yaml
KinesisTriggerTest:
CNMExampleWorkflow:
Comment: 'Tests Workflow from Kinesis Stream'
StartAt: StartStatus
States:
Expand Down
2 changes: 1 addition & 1 deletion docs/data-cookbooks/setup.md
Expand Up @@ -79,7 +79,7 @@ The Cumulus Core repository has an example of a Kinesis rule [here](https://gith
|Key |Value |Required|Description|
|:---:|:-----:|:------:|-----------|
|name|`"L2_HR_PIXC_kinesisRule"`|Yes|Name of the rule. This is the name under which the rule will be listed on the dashboard|
|workflow|`"KinesisTriggerTest"`|Yes|Name of the workflow to be run. A list of available workflows can be found on the Workflows page|
|workflow|`"CNMExampleWorkflow"`|Yes|Name of the workflow to be run. A list of available workflows can be found on the Workflows page|
|provider|`"PODAAC_SWOT"`|No|Configured provider's ID. This can be found on the Providers dashboard page|
|collection|`<JSON Object>` collection object shown [below](#collection-object)|Yes|Name and version of the collection this rule will moderate. Relates to a collection configured and found in the Collections page|
|rule|`<JSON Object>` rule type and associated values - discussed [below](#rule-object)|Yes|Object defining the type and subsequent attributes of the rule|
Expand Down
15 changes: 8 additions & 7 deletions docs/deployment/README.md
Expand Up @@ -54,9 +54,9 @@ The process involves:

## Installation

#### Prepare DAAC deployment repository {#prepare-deployment}
#### Prepare DAAC deployment repository

_If you already are working with an existing `<daac>-deploy` repository that is configured appropriately for the version of Cumulus you intend to deploy or update, skip to [Prepare AWS configuration. ](#prepare-config)_
_If you already are working with an existing `<daac>-deploy` repository that is configured appropriately for the version of Cumulus you intend to deploy or update, skip to [Prepare AWS configuration. ](#prepare-aws-configuration) _

Clone template-deploy repo and name appropriately for your DAAC or organization

Expand Down Expand Up @@ -121,7 +121,7 @@ To run the Cumulus deployment with the local code instead of the npm package, us

Note: If you get errors with `npm link`, try deleting the `node_modules` folder the package you are trying to link to in the Cumulus repository.

##### Copy the sample template into your repository {#copy-template}
##### Copy the sample template into your repository

The [`Cumulus`](https://github.com/nasa/cumulus) project contains default configuration values in the `app.example` folder, however these need to be customized for your Cumulus app.

Expand All @@ -137,7 +137,7 @@ Begin by copying the template directory to your project. You will modify it for
You can then [add/commit](https://help.github.com/articles/adding-a-file-to-a-repository-using-the-command-line/) changes as needed.


#### Prepare AWS configuration {#prepare-config}
#### Prepare AWS configuration

**Set Access Keys:**

Expand Down Expand Up @@ -234,7 +234,7 @@ The `iam` deployment also creates an instance profile named `<stack-name>-ecs` t
--------------
## Configure and Deploy the Cumulus stack

These updates configure the [copied template](#copy-template) from the cumulus repository for your DAAC.
These updates configure the [copied template](#copy-the-sample-template-into-your-repository) from the cumulus repository for your DAAC.

You should either add a new root-level key for your configuration or modify the existing default configuration key to whatever you'd like your new deployment to be.

Expand Down Expand Up @@ -272,7 +272,7 @@ Also note, if you dont specify the `amiid`, it will try to use a default, which

###### buckets

The config buckets should map to the same names you used when creating buckets in the [Prepare AWS](#prepare-config) step. Buckets are defined in the config.yml with a key, name, and type. Types should be one of: internal, public, private, or protected. Multiple buckets of each type can be configured.
The config buckets should map to the same names you used when creating buckets in the [Prepare AWS](#prepare-aws-configuration) step. Buckets are defined in the config.yml with a key, name, and type. Types should be one of: internal, public, private, or protected. Multiple buckets of each type can be configured.

###### iams

Expand Down Expand Up @@ -429,7 +429,7 @@ If you've lost track of the needed redirect URIs, they can be located on the [AP

**Create S3 bucket for dashboard:**

* Create it, e.g. `<prefix>-dashboard`. Use the command line or console as you did when [preparing AWS configuration](#Prepare AWS configuration).
* Create it, e.g. `<prefix>-dashboard`. Use the command line or console as you did when [preparing AWS configuration](#Prepare-AWS-configuration).
* Configure the bucket to host a website:
* AWS S3 console: Select `<prefix>-dashboard` bucket then, "Properties" -> "Static Website Hosting", point to `index.html`
* CLI: `aws s3 website s3://<prefix>-dashboard --index-document index.html`
Expand All @@ -442,6 +442,7 @@ To install the dashboard clone the Cumulus-dashboard repository into the root de

$ git clone https://github.com/nasa/cumulus-dashboard
$ cd cumulus-dashboard
$ nvm use
$ npm install

### Dashboard configuration
Expand Down

0 comments on commit eac2a6a

Please sign in to comment.