Source code for stochss_compute.cloud.ec2_config

'''
stochss_compute.cloud.ec2_config
'''
# StochSS-Compute is a tool for running and caching GillesPy2 simulations remotely.
# Copyright (C) 2019-2023 GillesPy2 and StochSS developers.

# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.

# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.

# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

import os

class EC2RemoteConfig:
    '''
    Configure remote settings.

    :param suffix: Add a suffix to all AWS resource names.
    :type suffix: str

    :param vpc_name: Identify the VPC.
    :type vpc_name: str

    :param subnet_name: Identify the subnet.
    :type subnet_name: str

    :param security_group_name: Identify the security group.
    :type security_group_name: str

    :param server_name: Identify the server.
    :type server_name: str
    
    :param key_name: Identify the AWS EC2 KeyPair.
    :type key_name: str

    :param api_port: Port to serve from.
    :type api_port: int
   
    :param region: Region to point to, like 'us-east-1' See `here <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions>`_.
    :type region: str

    :param ami: Custom AMI to use, like 'ami-09d3b3274b6c5d4aa'. See `here <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html>`_.
    :type ami: str
    '''
    _AMIS = {
        'us-east-1': 'ami-09d3b3274b6c5d4aa',
        'us-east-2': 'ami-089a545a9ed9893b6',
        'us-west-1': 'ami-017c001a88dd93847',
        'us-west-2': 'ami-0d593311db5abb72b',
    }

    def __init__(self,
                 suffix=None,
                 vpc_name='sssc-vpc',
                 subnet_name='sssc-subnet',
                 security_group_name='sssc-sg',
                 server_name='sssc-server',
                 key_name='sssc-server-ssh-key',
                 api_port=29681,
                 region=None,
                 ami=None,
                 ):
        if suffix is not None:
            suffix = f'-{suffix}'
        else:
            suffix = ''

        self.vpc_name = vpc_name + suffix
        self.subnet_name = subnet_name + suffix
        self.security_group_name = security_group_name + suffix
        self.server_name = server_name + suffix
        self.key_name = key_name + suffix
        self.api_port = api_port
        self.region = region
        self.ami = ami


class EC2LocalConfig:
    '''
    Configure local settings.

    :param key_dir: Path to a directory to store SSH key.
    :type key_dir: str

    :param key_name: Name for the file.
    :type key_name: str

    :param status_file: Path to a file to write instance status. Writes status to top line of that file.
    :type status_file: str

    :param key_type: ed25519 or rsa
    :type key_type: str

    :param key_format: pem or ppk
    :type key_format: str
    '''

    def __init__(self,
                 key_dir='./.sssc',
                 key_name='sssc-server-ssh-key',
                 status_file=None,
                 key_type='ed25519',
                 key_format='pem',
                 ):
        self.key_dir = key_dir
        self._key_filename = f'{key_name}.{key_format}'
        self.key_type = key_type
        self.key_format = key_format
        self.key_path = os.path.abspath(
            os.path.join(self.key_dir, self._key_filename))
        self.status_file = status_file