Skip to content

Update documentation with SSH requirements and Ubuntu 22 support#15

Merged
theFong merged 2 commits intomainfrom
devin/1754357237-update-ssh-ubuntu-docs
Aug 7, 2025
Merged

Update documentation with SSH requirements and Ubuntu 22 support#15
theFong merged 2 commits intomainfrom
devin/1754357237-update-ssh-ubuntu-docs

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Aug 6, 2025

Update documentation with SSH requirements and Ubuntu 22 support

Summary

This PR adds explicit documentation for two key requirements that were previously implicit in the Brev Cloud SDK:

  1. SSH Access Requirements: Added comprehensive documentation specifying that Brev depends on SSH server functionality and SSH key-based authentication for instance access
  2. Platform Support: Explicitly documented that the SDK currently supports Ubuntu 22 only

The changes include updates to the main security documentation and all three provider-specific security files (Lambda Labs, Nebius, FluidStack) to ensure consistency across the SDK documentation.

Review & Testing Checklist for Human

  • Verify SSH server support claims: Confirm that Lambda Labs, Nebius, and FluidStack actually support SSH server pre-installation and SSH key injection as documented
  • Validate Ubuntu 22 requirement: Check if "Ubuntu 22 only" is accurate or if other Ubuntu versions/OSes should be supported
  • Review SSH security integration: Ensure SSH access requirements align with each provider's firewall rules and security group configurations
  • Test SSH implementation: Verify that actual SDK implementations support the documented SSH key injection and server access methods

Recommended Test Plan: Create test instances with each provider to verify SSH server is running, SSH key injection works during provisioning, and access works within documented security models.


Diagram

%%{ init : { "theme" : "default" }}%%
graph TD
    MainSec["docs/SECURITY.md<br/>Main Security Requirements"]:::major-edit
    ReadMe["README.md<br/>Project Overview"]:::major-edit
    
    LambdaSec["internal/lambdalabs/SECURITY.md<br/>Lambda Labs Provider"]:::major-edit
    NebiusSec["internal/nebius/SECURITY.md<br/>Nebius Provider"]:::major-edit
    FluidSec["internal/fluidstack/v1/SECURITY.md<br/>FluidStack Provider"]:::major-edit
    
    MainSec --> LambdaSec
    MainSec --> NebiusSec
    MainSec --> FluidSec
    
    ReadMe -.-> MainSec
    
    subgraph Legend
        L1[Major Edit]:::major-edit
        L2[Minor Edit]:::minor-edit
        L3[Context/No Edit]:::context
    end

    classDef major-edit fill:#90EE90
    classDef minor-edit fill:#87CEEB
    classDef context fill:#FFFFFF
Loading

Notes

  • All changes are documentation-only with no code modifications
  • SSH requirements were added consistently across all provider documentation
  • Ubuntu 22 support specification was added to main README
  • Documentation follows existing security model patterns (deny inbound, allow outbound)
  • Changes maintain consistency with each provider's specific security implementation details

Session Info: https://app.devin.ai/sessions/5c677003f37d40f3b4a28597f8c3687a
Requested by: Alec Fong (@theFong)

- Add SSH server requirements and SSH key authentication to SECURITY.md
- Specify Ubuntu 22 as currently supported OS in README.md
- Include SSH access method requirements in platform support section

Co-Authored-By: Alec Fong <alecsanf@usc.edu>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

- Add SSH server requirements to Lambda Labs SECURITY.md
- Add SSH server requirements to Nebius SECURITY.md
- Add SSH server requirements to FluidStack SECURITY.md
- Ensure consistency with main docs/SECURITY.md SSH requirements

Co-Authored-By: Alec Fong <alecsanf@usc.edu>
@theFong theFong merged commit d6a7d14 into main Aug 7, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant