Skip to content

Commit

Permalink
Bump version to 1.0.0dev1
Browse files Browse the repository at this point in the history
Add CITATION.cff
Update readme
  • Loading branch information
medley56 committed Oct 8, 2024
1 parent 0b9e24f commit ff4d15f
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 69 deletions.
24 changes: 24 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
cff-version: 1.2.0
title: 'lasp_opensearch_data_center'
type: software
version: '1.0.0'
description: An AWS CDK Construct library for creating an I&T data center using AWS OpenSearch.
license: BSD-3-Clause
abstract: The LASP OpenSearch Data Center library contains AWS CDK Constructs and assorted utilities for creating
an Integration and Test data center in the cloud. The Constructs defined in the library using the AWS CDK to
create storage resources, an OpenSearch cluster/domain, and orchestration resources for automatically
ingesting data into OpenSearch using Lambda functions defined by the end user.
authors:
- email: [email protected]
name: Gavin Medley
orcid: "0000-0002-3520-9715"
- email: [email protected]
name: Brian McClellan
orcid: "0009-0002-8228-1485"
- name: Luke Soderquist
maintainers:
- email: [email protected]
name: Gavin Medley
orcid: "0000-0002-3520-9715"
repository-code: "https://github.com/lasp/lasp-opensearch-data-center"
url: ""
70 changes: 2 additions & 68 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,11 @@
# LASP OpenSearch Data Center CDK Constructs

A construct library for implementing an OpenSearch data center. This library contains the following constructs:
* BackendStorageConstruct
* BackupVault
* Certificate
* FrontendStorageConstruct
* NetworkingComponents
* Frontend
* OpenSearch
* CloudWatchAlarmConstruct
* Ingest
* DynamoQuery

Example usage:

```
domain_name = "example.com"
self.frontendStorage = FrontendStorage(
self, domain_name, construct_id, environment, **kwargs
)
account_type = "dev"
self.backendStorage = BackendStorage(
self,
construct_id,
dropbox_bucket_name=f"{account_type}-example-dropbox",
ingest_bucket_name=f"{account_type}-example-ingest",
opensearch_snapshot_bucket_name=f"{account_type}-example-opensearch-manual-snapshot",
)
frontend_bucket = self.frontendStorage.frontend_bucket
self.frontend = FrontEndConstruct(
self,
construct_id=construct_id,
account_type=account_type,
domain_name=domain_name,
frontend_bucket=frontend_bucket,
waf_ip_range="1.1.1.0/24", # Example IP range
environment=environment,
)
self.networking = NetworkingComponentsConstruct(self, construct_id)
self.certificate = CertificateConstruct(
self, "CertificateConstruct", domain_name
)
# TODO: add example usage for constructs as they are completed
```

### Networking Construct
L3 Construct containing a custom VPC with specific subnet configurations.

### Back End Storage Construct
L3 Construct containing the necessary storage infrastructure that supports the back end ingest pipeline and
Opensearch.

### Ingest Construct
Not yet implemented as a L3 Construct
A construct library for implementing an OpenSearch data center.

# Installation

The package is available on PyPI:

```shell
pip install lasp-opensearch-data-center
```

# Roadmap and Plans

- Incorporate the last L3 construct for OpenSearch and data ingest
- Add static code analysis and automated security testing (e.g. Bandit) using Github actions
- Write user documentation for putting these lego blocks together, including example code for Stacks (e.g. an example CDK app)
- Will include detailed instructions on customizing ingest handler code
- Clean up the docstrings and improve overall code polish
- Write developer documentation for developing further
```
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "lasp_opensearch_data_center"
version = "1.0.0rc1"
version = "1.0.0dev1"
description = "Construct library for creating a CSV ingest pipeline into OpenSearch with a front end website."
authors = [
"Gavin Medley <[email protected]>",
Expand Down

0 comments on commit ff4d15f

Please sign in to comment.