Skip to content

Commit

Permalink
updating structure of files and the delivery tooling
Browse files Browse the repository at this point in the history
  • Loading branch information
damienjburks committed Jan 9, 2025
1 parent 7c8e20d commit 3d9aeb7
Show file tree
Hide file tree
Showing 5 changed files with 164 additions and 53 deletions.
4 changes: 2 additions & 2 deletions docs/resources/training/Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
## Links

- [OSCAL](https://github.com/finos/common-cloud-controls/blob/main/docs/resources/training/oscal/oscal.md)
- [Markdown Linting and Formatting - End User Guide](./lint_format_user_guide.md)
- [Markdown Linting and Formatting - End User Guide](user_guides/linting_and_formatting.md)
- [FINOS CCC Primer](./FINOS-CCC-Primer-June-2024.pdf)
- [delivery-toolkit - User Guide](delivery_toolkit.md)
- [delivery-toolkit - User Guide](user_guides/delivery_toolkit.md)
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ To contribute to this project, ensure you have the following tools installed:
Once installed, open VS Code and add the following extension:

- **Go VS Code Extension**: [Install here](https://marketplace.visualstudio.com/items?itemName=golang.go)
![VS Code Extensions](image.png)
![VS Code Extensions](./imgs/delivery_toolkit_go_extension.png)

### Installing Dependencies

Expand All @@ -51,28 +51,27 @@ Once installed, open VS Code and add the following extension:
go get # Installs all required dependencies
```

1. Once you install all of the dependencies, run this command to confirm everything works:
1. Once all dependencies are installed, run this command to confirm the setup:

```bash
go run .

# Output
# Output Example
----------------------------------------

Welcome to the CCC Delivery Tooling CLI v0.0.0-dev
_______________
_______________
/ ___/ ___/ ___/
/ / / / / /
/ /__/ /__/ /___
\____/____/____/
/ / / / / /
/ /__/ /__/ /___
\____/____/____/

----------------------------------------

Welcome to the CCC Delivery Toolkit CLI v0.0.0-dev

You appear to be exploring!
We suggest you begin by running the 'help' command via -h to review the available options.

----------------------------------------

```

1. Set up the Docker container for PDF generation by pulling the required image:
Expand All @@ -83,6 +82,91 @@ Once installed, open VS Code and add the following extension:

## Testing Locally

To generate artifacts and test commands locally for Object Storage specifically (as an example), use the following commands:

- **Generating an Omnibus MD File**

```bash
go run . "md" -t ..\services\storage\object\

# Output Example
----------------------------------------
_______________
/ ___/ ___/ ___/
/ / / / / /
/ /__/ /__/ /___
\____/____/____/

----------------------------------------

File generated successfully: artifacts\CCC.ObjStor_2025.01.md

----------------------------------------
```

- **Generating a YAML File**

```bash
go run . "yaml" -t ..\services\storage\object\

# Output Example
----------------------------------------
_______________
/ ___/ ___/ ___/
/ / / / / /
/ /__/ /__/ /___
\____/____/____/

----------------------------------------

File generated successfully: ./artifacts/CCC.ObjStor_2025.01.yaml

----------------------------------------
```

- **Generating Release Notes**

```bash
go run . "release-notes" -t ..\services\storage\object\

# Output Example
----------------------------------------
_______________
/ ___/ ___/ ___/
/ / / / / /
/ /__/ /__/ /___
\____/____/____/

----------------------------------------

File generated successfully: artifacts\release_notes.md

----------------------------------------
```

- **Updating Metadata**

```bash
go run . "update-metadata" -t ..\services\storage\object\

# Output Example
----------------------------------------
_______________
/ ___/ ___/ ___/
/ / / / / /
/ /__/ /__/ /___
\____/____/____/

----------------------------------------

Contributors and Change Log has been updated.
Metadata has been updated successfully: ..\services\storage\object\metadata.yaml

----------------------------------------
```

**NOTE:** This command should only be used when preparing for a release, as it modifies the `metadata.yaml` files for a given service.

## Triggering Pipelines

### Triggering Pipeline
TBD/WIP!
File renamed without changes
Original file line number Diff line number Diff line change
Expand Up @@ -72,4 +72,4 @@ Thanks for reading. At this point, you have now successfully installed and confi

If you have any issues, please do not hesistate to reach out to the [Delivery WG] for more assistance.

[Delivery WG]: ../../governance/working-groups/delivery/charter.md
[Delivery WG]: ../../../governance/working-groups/delivery/charter.md
105 changes: 66 additions & 39 deletions services/storage/object/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,44 +8,71 @@ description: |
highly scalable and often used in cloud environments due to its flexibility
and accessibility.
release_details:
- version: "2025.01"
assurance_level: None
threat_model_url: None
threat_model_author: None
red_team: None
red_team_exercise_url: None
release_manager:
name: Damien Burks
github_id: damienjburks
company: Citi
summary: |
This initial release is part of the first batch of control catalogs
produced by the CCC. It is the result of thousands of hours dedicated to
exploring different ways of working and collaborating, on top of time
spent researching, writing, and reviewing the content. This marks a huge
milestone for the CCC and the broader community as further releases will
continue to build on this foundation. A huge thanks to everyone who has
brought us to this point!
change_log:
- |
This initial release contains a variety of commits designed to capture
all of the features, threats, and controls for this service category.
contributors:
- name: Sonali Mendis
github_id: smendis-scottlogic
company: Scott Logic
- name: Eddie Knight
github_id: eddie-knight
company: Sonatype
- name: Michael Lysaght
github_id: mlysaght2017
company: Citi
- name: Dave Ogle
github_id: dogle-scottlogic
company: Scott Logic
- name: Damien Burks
- version: "2025.01"

Check failure on line 11 in services/storage/object/metadata.yaml

View workflow job for this annotation

GitHub Actions / run-linting-check / yaml-lint

11:5 [indentation] wrong indentation: expected 2 but found 4
assurance_level: None
threat_model_url: None
threat_model_author: None
red_team: None
red_team_exercise_url: None
release_manager:
name: Damien Burks
github_id: damienjburks
company: Citi
- name: Naseer Mohammad
github_id: nas-hub
company: Google
summary: |
This initial release is part of the first batch of control catalogs
produced by the CCC. It is the result of thousands of hours dedicated to
exploring different ways of working and collaborating, on top of time
spent researching, writing, and reviewing the content. This marks a huge
milestone for the CCC and the broader community as further releases will
continue to build on this foundation. A huge thanks to everyone who has
brought us to this point!
change_log:
- VPC Networking Release - 2025.01 (#584)
- Object Storage Release - 2025.01 (#581)
- Formatting changes for VPC and Object Storage (#578)
- Polished ObjStor Test Requirements (#577)
- Add in fixes to control definitions (#570)
- '#534: Add yaml linter (#543)'
- Add in updates to soft and hard delete bucket controls (#528)
- October Release Candidate - Object Storage (#445)
- Add in fixes to object storage threats, controls, features (#436)
- Typofix on control IDs (#432)
- Object storage final polish (#419)
- Adding Contributors key to metadata schema (#409)
- Object Storage Controls Revision (#394)
- GenAI taxonomy (#393)
- Updates to the structure of the metadata yaml (#383)
- Schema updates (#377)
- Handling common entries for features, threats, & controls (#327)
- Convert Object Storage development files from MD to YAML (#325)
- Add in new object storage controls on encryption for impact and replication to untrusted destinations (#305)
- Convert existing taxonomies to the new yaml format (#319)
- Fix broken links (#317)
- Added CCC.OS.C6 Control (#298)Looks good
- Extend Object Storage Controls (#263)
- Creation of Global Markdown Formatting and Linting GitHub Actions (#223)
- Draft Proposal for Threat Catalog and Control Catalog Taxonomy (#153)
- Signed URLs added
- addressed review comments by @rgriffiths-scottlogic
- address review comments by stevie from scott logic and further improvements
- updates
- initial version of the object store taxonomy
contributors:
- name: Damien Burks
github_id: damienjburks
company: REPLACE_ME
- name: Sonali Mendis
github_id: smendis-scottlogic
company: REPLACE_ME
- name: Eddie Knight
github_id: eddie-knight
company: REPLACE_ME
- name: Michael Lysaght
github_id: mlysaght2017
company: REPLACE_ME
- name: Dave Ogle
github_id: dogle-scottlogic
company: REPLACE_ME
- name: Naseer Mohammad
github_id: nas-hub
company: REPLACE_ME

0 comments on commit 3d9aeb7

Please sign in to comment.