cloudx-proxy 0.3.1__py3-none-any.whl → 0.3.3__py3-none-any.whl

cloudx_proxy/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.3.1'
-__version_tuple__ = version_tuple = (0, 3, 1)
+__version__ = version = '0.3.3'
+__version_tuple__ = version_tuple = (0, 3, 3)

{cloudx_proxy-0.3.1.dist-info → cloudx_proxy-0.3.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: cloudx-proxy
-Version: 0.3.1
+Version: 0.3.3
 Summary: SSH proxy command to connect VSCode with Cloud9/CloudX instance using AWS Systems Manager
 Author-email: easytocloud <info@easytocloud.com>
 License: MIT License
@@ -63,16 +63,37 @@ cloudX-proxy enables seamless SSH connections from VSCode to EC2 instances using
 
 ## Prerequisites
 
-1. **AWS CLI v2** - [Installation Guide](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
-2. **AWS Session Manager Plugin** - [Installation Guide](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html)
-3. **OpenSSH Client**
+1. **AWS CLI v2** - Used to configure AWS profiles and credentials
+   - [Installation Guide](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html)
+   - Required for `aws configure` during setup
+   - Handles AWS credentials and region configuration
+
+2. **AWS Session Manager Plugin** - Enables secure tunneling through AWS Systems Manager
+   - [Installation Guide](https://docs.aws.amazon.com/systems-manager/latest/userguide/session-manager-working-with-install-plugin.html)
+   - Provides the secure connection channel
+   - No need for public IP addresses or direct SSH access
+
+3. **OpenSSH Client** - Handles SSH key management and connections
    - Windows: [Microsoft's OpenSSH Installation Guide](https://learn.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse?tabs=gui)
    - macOS/Linux: Usually pre-installed
-4. **uv** - Python package installer and resolver
+   - Manages SSH keys and configurations
+   - Provides the SSH client for VSCode Remote
+
+4. **uv** - Modern Python package installer and virtual environment manager
    ```bash
    pip install uv
    ```
-5. **VSCode with Remote SSH Extension** installed
+   The `uvx` command from uv automatically:
+   - Creates an isolated virtual environment for each package
+   - Downloads and installs the package and its dependencies
+   - Runs the package without explicit environment activation
+   
+   This means you can run cloudX-proxy directly with `uvx cloudx-proxy` without manually managing virtual environments or dependencies.
+
+5. **VSCode with Remote SSH Extension** - Your development environment
+   - Provides the integrated development environment
+   - Uses the SSH configuration to connect to instances
+   - Handles file synchronization and terminal sessions
 
 ## AWS Credentials Setup
 
@@ -81,19 +102,11 @@ The proxy expects to find AWS credentials in a profile named 'vscode' by default
 - Establishing SSM sessions
 - Pushing SSH keys via EC2 Instance Connect
 
-Once the SSH session is established, the user has to further configure the instance using `generate-sso-config` tool. This is a one-time setup unless the user's access to AWS accounts changes, in which case the user should re-run the `generate-sso-config` tool.
-
-It is recommended to use  --generate-directories and --use-ou-structure to create working directories for each account the user has access to.
-
-Everytime the user connects to the instance, `ssostart` will authenticate the user with AWS SSO and generate temporary credentials. 
-
-This ensures you have the appropriate AWS access both for connecting to the instance and for working within it.
-
-The proxy also supports easytocloud's AWS profile organizer. If you use multiple AWS environments, you can store your AWS configuration and credentials in `~/.aws/aws-envs/<environment>` directories and use the `--aws-env` option to specify which environment to use.
+The proxy supports easytocloud's AWS profile organizer for managing multiple AWS environments. You can store your AWS configuration and credentials in `~/.aws/aws-envs/<environment>` directories and use the `--aws-env` option to specify which environment to use.
 
 ## Setup
 
-cloudX-proxy now includes a setup command that automates the entire configuration process:
+cloudX-proxy includes a setup command that automates the entire configuration process:
 
 ```bash
 # Basic setup with defaults (vscode profile and key)
@@ -130,25 +143,23 @@ The setup command will:
    - Offers to wait for setup completion
    - Monitors setup progress
 
-### Example SSH Configuration
+### SSH Configuration
 
-The setup command generates a configuration structure like this:
+The setup command configures SSH to use cloudX-proxy as a ProxyCommand, enabling seamless connections through AWS Systems Manager. It creates:
 
-```
-# Base environment config (created once per environment)
-Host cloudx-{env}-*
-    User ec2-user
-    IdentityAgent ~/.1password/agent.sock  # If using 1Password
-    IdentityFile ~/.ssh/vscode/key.pub    # .pub for 1Password, no .pub otherwise
-    IdentitiesOnly yes                    # If using 1Password
-    ProxyCommand uvx cloudx-proxy connect %h %p --profile profile --aws-env env
-
-# Host entries (added for each instance)
-Host cloudx-{env}-hostname
-    HostName i-1234567890
-```
+1. A base configuration for each environment (cloudx-{env}-*) with:
+   - User and key settings
+   - 1Password integration if selected
+   - ProxyCommand with appropriate parameters
+
+2. Individual host entries for each instance:
+   - Uses consistent naming (cloudx-{env}-hostname)
+   - Maps to instance IDs automatically
+   - Inherits environment-level settings
 
-When adding new instances to an existing environment, the setup command will only add the specific host entry, preserving the existing environment configuration.
+When adding new instances to an existing environment, you can choose to:
+- Override the environment configuration with new settings
+- Add instance-specific settings while preserving the environment config
 
 ### VSCode Configuration
 
@@ -163,28 +174,62 @@ When adding new instances to an existing environment, the setup command will onl
 
 ## Usage
 
-### Command Line
+### Command Line Options
 
+#### Setup Command
 ```bash
-# Setup new environment and instance
-uvx cloudx-proxy setup --profile myprofile --aws-env prod
+uvx cloudx-proxy setup [OPTIONS]
+```
+
+Options:
+- `--profile` (default: vscode): AWS profile to use. The profile's IAM user should follow the format cloudX-{env}-{user}. The environment part will be used as the default environment during setup.
+- `--ssh-key` (default: vscode): Name of the SSH key to create/use. The key will be stored in ~/.ssh/vscode/{name}. This same name can be used in the connect command.
+- `--aws-env` (optional): AWS environment directory to use. If specified, AWS configuration and credentials will be read from ~/.aws/aws-envs/{env}/.
+
+Example usage:
+```bash
+# Basic setup with defaults
+uvx cloudx-proxy setup
+
+# Setup with custom profile and key
+uvx cloudx-proxy setup --profile myprofile --ssh-key mykey
 
-# Add instance to existing environment
+# Setup with AWS environment
 uvx cloudx-proxy setup --profile myprofile --aws-env prod
+```
 
-# Connect to instance
-uvx cloudx-proxy connect i-0123456789abcdef0 22 --profile myprofile --aws-env prod
+#### Connect Command
+```bash
+uvx cloudx-proxy connect INSTANCE_ID [PORT] [OPTIONS]
+```
+
+Arguments:
+- `INSTANCE_ID`: The EC2 instance ID to connect to (e.g., i-0123456789abcdef0)
+- `PORT` (default: 22): The port to forward for SSH connection
 
-# Connect with custom port
-uvx cloudx-proxy connect i-0123456789abcdef0 2222 --profile myprofile
+Options:
+- `--profile` (default: vscode): AWS profile to use. Should match the profile used in setup.
+- `--ssh-key` (default: vscode): Name of the SSH key to use. Should match the key name used in setup.
+- `--region` (optional): AWS region to use. If not specified, uses the region from the AWS profile.
+- `--aws-env` (optional): AWS environment directory to use. Should match the environment used in setup.
+
+Example usage:
+```bash
+# Connect using defaults
+uvx cloudx-proxy connect i-0123456789abcdef0
 
-# Connect with different region
-uvx cloudx-proxy connect i-0123456789abcdef0 22 --region us-east-1
+# Connect with custom profile and key
+uvx cloudx-proxy connect i-0123456789abcdef0 22 --profile myprofile --ssh-key mykey
 
-# Connect with custom key
-uvx cloudx-proxy connect i-0123456789abcdef0 22 --key-path ~/.ssh/custom_key.pub
+# Connect with custom port and region
+uvx cloudx-proxy connect i-0123456789abcdef0 2222 --region us-east-1
+
+# Connect with AWS environment
+uvx cloudx-proxy connect i-0123456789abcdef0 22 --profile myprofile --aws-env prod
 ```
 
+Note: The connect command is typically used through the SSH ProxyCommand configuration set up by the setup command. You rarely need to run it directly unless testing the connection.
+
 ### VSCode
 
 1. Click the "Remote Explorer" icon in the VSCode sidebar
@@ -195,7 +240,7 @@ uvx cloudx-proxy connect i-0123456789abcdef0 22 --key-path ~/.ssh/custom_key.pub
 
 ## AWS Permissions
 
-The AWS user/role needs these permissions:
+The AWS user needs these permissions:
 
 ```json
 {
@@ -215,6 +260,7 @@ The AWS user/role needs these permissions:
     ]
 }
 ```
+Note: This user should be created using the cloudX-user product from Service Catalog in the AWS Console. This assures proper permissions and naming conventions.
 
 ## Troubleshooting
 

cloudx_proxy-0.3.3.dist-info/RECORD

@@ -0,0 +1,11 @@
+cloudx_proxy/__init__.py,sha256=ZZ2O_m9OFJm18AxMSuYJt4UjSuSqyJlYRaZMoets498,61
+cloudx_proxy/_version.py,sha256=FKnJIExgNrZG2xJ0y_dGNBpxGbGBYylvfat-jHhLUuM,411
+cloudx_proxy/cli.py,sha256=Ph-m8lDsdU2zZab9Y6YgBBzd_UDouBnfNrYFFx0bI_E,3426
+cloudx_proxy/core.py,sha256=WjKoqMmmnt6e_4JMeq4gTka75JAvQcMUs9r9XUBLmFE,7289
+cloudx_proxy/setup.py,sha256=Y8YYMJ47fb57FAr6llQaFGuVOQ-fstYEg_Pdv5uCd-A,22486
+cloudx_proxy-0.3.3.dist-info/LICENSE,sha256=i7P2OR4zsJYsMWcCUDe_B9ZfGi9bU0K5I2nKfDrW_N8,1068
+cloudx_proxy-0.3.3.dist-info/METADATA,sha256=AgKxYfcB9ld5fuvmXyuxPqffxQoV2MoeCOf6LhjKJ44,12247
+cloudx_proxy-0.3.3.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+cloudx_proxy-0.3.3.dist-info/entry_points.txt,sha256=HGt743N2lVlKd7O1qWq3C0aEHyS5PjPnxzDHh7hwtSg,54
+cloudx_proxy-0.3.3.dist-info/top_level.txt,sha256=2wtEote1db21j-VvkCJFfT-dLlauuG5indjggYh3xDg,13
+cloudx_proxy-0.3.3.dist-info/RECORD,,

cloudx_proxy-0.3.1.dist-info/RECORD

@@ -1,11 +0,0 @@
-cloudx_proxy/__init__.py,sha256=ZZ2O_m9OFJm18AxMSuYJt4UjSuSqyJlYRaZMoets498,61
-cloudx_proxy/_version.py,sha256=HzPz9rq3s1AiZXregKlqKaJJ2wGMtvH_a3V9la9CnpM,411
-cloudx_proxy/cli.py,sha256=Ph-m8lDsdU2zZab9Y6YgBBzd_UDouBnfNrYFFx0bI_E,3426
-cloudx_proxy/core.py,sha256=WjKoqMmmnt6e_4JMeq4gTka75JAvQcMUs9r9XUBLmFE,7289
-cloudx_proxy/setup.py,sha256=Y8YYMJ47fb57FAr6llQaFGuVOQ-fstYEg_Pdv5uCd-A,22486
-cloudx_proxy-0.3.1.dist-info/LICENSE,sha256=i7P2OR4zsJYsMWcCUDe_B9ZfGi9bU0K5I2nKfDrW_N8,1068
-cloudx_proxy-0.3.1.dist-info/METADATA,sha256=9IDcysHjzmeyFMs0ODmS6gfC98rXcCyj-Ug2RsJBxyI,10216
-cloudx_proxy-0.3.1.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-cloudx_proxy-0.3.1.dist-info/entry_points.txt,sha256=HGt743N2lVlKd7O1qWq3C0aEHyS5PjPnxzDHh7hwtSg,54
-cloudx_proxy-0.3.1.dist-info/top_level.txt,sha256=2wtEote1db21j-VvkCJFfT-dLlauuG5indjggYh3xDg,13
-cloudx_proxy-0.3.1.dist-info/RECORD,,