Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document architecture and required ports #354

Closed
safiuddinr opened this issue Jul 9, 2024 · 2 comments
Closed

Document architecture and required ports #354

safiuddinr opened this issue Jul 9, 2024 · 2 comments
Assignees
Labels
Points: 6 Story Point (3 days)
Milestone

Comments

@safiuddinr
Copy link
Collaborator

safiuddinr commented Jul 9, 2024

We need to document LME 2.0 and the architecture changes, how to install it, and other necesary documentation

@safiuddinr safiuddinr converted this from a draft issue Jul 9, 2024
@safiuddinr safiuddinr changed the title document architecture and required ports Document architecture and required ports Jul 9, 2024
@safiuddinr safiuddinr moved this from 🔖 Sprint Backlog to 🏗 In Progress in LME-Development Jul 23, 2024
@safiuddinr safiuddinr moved this from 🏗 In Progress to 👀 In Review in LME-Development Jul 24, 2024
@mreeve-snl mreeve-snl linked a pull request Jul 25, 2024 that will close this issue
8 tasks
@mreeve-snl mreeve-snl added the Points: 6 Story Point (3 days) label Jul 25, 2024
@safiuddinr safiuddinr added this to the LME 2.0 milestone Aug 6, 2024
@mreeve-snl
Copy link
Collaborator

Notes for my now closed PR that is covered by #392

This Merges the Content of the Proposed drafts and Vision for LME 2.0

Adds the Following:

Scripts:
    download.sh/upload.sh: upload/download logs in mass from elasticsearch
    (will be integrated into future merging from 1 -> 2)
    link_latest_podman_quadlet.sh: links from the nix store the latest
    podman version into its expected directories
    set-fleet.sh: sets up the required fleet settings on kibana
    set_sysctl_limits.sh: sets the sysctl_limits as required by the
    architecture and containers
    install_lme_local.yml: sets up the ansible playbook for lme 2.0
    installation.
quadlets: the original compose spec of the architecture is broken into podman quadlets for better support, easier development, better security, and overall useability.
Old chapters are moved to their own directory, this will be removed before merge to main
adds an ansible playbook to install lme
updates Readme with documentation for running everything.

💭 Motivation and context

Begins instantiating the LME 2.0 vision:

secure

passwords stored securely
podman

easy to deploy:

migrating deploy.sh -> to a python versioning system (ansible)
data/configuration seperate from code version control

useful and full Q/A:

unit tests (native python as much as possible)
pipeline of deployment/testing
    cluster install
    linux solo server install
threat emulation

The old LME 1.0 had issues and this aims to solve them with the above vision ^^

@mreeve-snl
Copy link
Collaborator

looks like ports are also documented: https://github.com/cisagov/LME/tree/release-2.0.0?tab=readme-ov-file#required-ports

so we're good to close this :)

@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in LME-Development Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Points: 6 Story Point (3 days)
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

2 participants