@aws/workbench-core-audit

Package containing an audit service with reference implementation


License
Apache-2.0
Install
npm install @aws/workbench-core-audit@1.0.0

Documentation

Overview

Research Service Workbench on AWS is a backend API designed to empower AWS partners to more easily build self-service portals for research institutions, allowing their researchers to create and manage secure research computing environments. RSW builds on AWS services including Amazon S3, Service Catalog, and AWS Systems Manager to deliver comprehensive, cutting-edge capabilities in less time while meeting the high bar for security and governance demanded by regulators and funding agencies.

Using a custom built portal provided by a partner, built on Research Service Workbench, research IT departments can more easily work with partners to deliver a self-service portal with a comprehensive catalog of tools tailored to the needs of the researchers they support. Using a portal built using RSW, researchers can create, access, and retire environments without needing to be experts on cloud infrastructure or security. They can work individually or collaborate with others on the same data, with RSW securely orchestrating the connection of research environments to Amazon S3. Furthermore, environments are deployed in specific AWS accounts and Amazon Virtual Private Clouds (VPCs), allowing connectivity to resources on and off campus. Institutions are fully in control of their data, data flows, and AWS footprint. They can scale investments in IT and security across multiple research programs, reducing duplicate effort and freeing up resources to focus on science.

To learn more about FWoA and how to deploy, refer to the Research Service Workbench Implementation Guide.

Codecov

main branch coverage

codecov

develop branch coverage

codecov

Workflow Status

Merge-develop-to-stage Release integration tests Commitizen friendly

Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional documentation, we greatly value feedback and contributions from our community.

Please read through this document before submitting any issues or pull requests to ensure we have all the necessary information to effectively respond to your bug report or contribution.

Code development and testing

In order to start developement please refer to Development Instructions

Packages

Folder Package README
solutions/swb-app [@aws/swb-app] README
workbench-core/accounts [@aws/workbench-core-accounts] README
workbench-core/accounts-ui [@aws/workbench-core-accounts-ui] README
workbench-core/audit [@aws/workbench-core-audit] README
workbench-core/authentication [@aws/workbench-core-authentication] README
workbench-core/authorization [@aws/workbench-core-authorization] README
workbench-core/base [@aws/workbench-core-base] README
workbench-core/datasets [@aws/workbench-core-datasets] README
workbench-core/datasets-ui [@aws/workbench-core-datasets-ui] README
workbench-core/environments [@aws/workbench-core-environments] README
workbench-core/environments-ui [@aws/workbench-core-environments-ui] README
workbench-core/infrastructure [@aws/workbench-core-infrastructure] README
workbench-core/logging [@aws/workbench-core-logging] README
workbench-core/swb-common-ui [@aws/workbench-core-swb-common-ui] README
workbench-core/user-management [@aws/workbench-core-user-management] README

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.

Code of Conduct

This project has adopted the Amazon Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opensource-codeofconduct@amazon.com with any additional questions or comments.

Security issue notifications

If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our vulnerability reporting page. Please do not create a public github issue.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.

Metrics Collection

This solution collects anonymous operational metrics to help AWS improve the quality of features of the solution. For more information, including how to disable this capability, please see the Implementation Guide.