server#
todo: doc string
- class acore_server_config.config.define.server.Server(id: ~typing.Optional[str] = None, ec2_ami_id: ~typing.Optional[str] = None, ec2_instance_type: ~typing.Optional[str] = None, ec2_subnet_id: ~typing.Optional[str] = None, ec2_key_name: ~typing.Optional[str] = None, ec2_eip_allocation_id: ~typing.Optional[str] = None, acore_soap_app_version: ~typing.Optional[str] = None, acore_db_app_version: ~typing.Optional[str] = None, acore_server_bootstrap_version: ~typing.Optional[str] = None, db_snapshot_id: ~typing.Optional[str] = None, db_instance_class: ~typing.Optional[str] = None, db_engine_version: ~typing.Optional[str] = None, db_admin_username: ~typing.Optional[str] = None, db_admin_password: ~typing.Optional[str] = None, db_username: ~typing.Optional[str] = None, db_password: ~typing.Optional[str] = None, lifecycle: ~typing.Optional[str] = None, authserver_conf: ~typing.Dict[str, str] = <factory>, worldserver_conf: ~typing.Dict[str, str] = <factory>, mod_lua_engine_conf: ~typing.Dict[str, str] = <factory>)[source]#
Per Game Server configuration.
- Parameters:
id – Server id, the naming convention is
${env_name}-${server_name}.ec2_ami_id – the AMI id for the game server.
ec2_instance_type – the EC2 instance type for the game server.
ec2_subnet_id – the EC2 subnet id for the game server.
ec2_key_name – the EC2 ssh key name for the game server.
ec2_eip_allocation_id – if you need a static IP, then create an Elastic IP address and put the allocation id here. otherwise, use the automatic public IP address.
acore_soap_app_version – the acore_soap_app-project git tag for bootstrap.
acore_server_bootstrap_version – the acore_server_bootstrap-project git tag for bootstrap.
db_snapshot_id – the snapshot id to create the RDS DB instance.
db_instance_class – the RDS instance class for the game database.
db_engine_version – the RDS engine version (all the way to minor).
db_admin_username – the RDS admin username, usually this is admin.
db_admin_password – the RDS admin password, we need this password. to create the database user for game server.
db_username – the database user for game server.
db_password – the database password for game server.
lifecycle – the logic “game server (both EC2 and RDS)” lifecycle definition.
authserver_conf – custom config for authserver.conf.
worldserver_conf – custom config for worldserver.conf.
mod_lua_engine_conf – custom config for mod_LuaEngine.conf.
- is_ready_for_create_new_server() bool[source]#
Check if the configuration is sufficient for creating new server.
See: https://acore-server.readthedocs.io/en/latest/search.html?q=Operation+and+Workflow&check_keywords=yes&area=default#
- is_ready_for_create_cloned_server() bool[source]#
Check if the configuration is sufficient for creating cloned server.
See: https://acore-server.readthedocs.io/en/latest/search.html?q=Operation+and+Workflow&check_keywords=yes&area=default#
- is_ready_for_create_updated_server() bool[source]#
Check if the configuration is sufficient for creating updated server.
See: https://acore-server.readthedocs.io/en/latest/search.html?q=Operation+and+Workflow&check_keywords=yes&area=default#
- is_ready_for_stop_server() bool[source]#
Check if the configuration is sufficient for stopping server.
See: https://acore-server.readthedocs.io/en/latest/search.html?q=Operation+and+Workflow&check_keywords=yes&area=default#
- is_ready_for_start_server() bool[source]#
Check if the configuration is sufficient for starting server.
See: https://acore-server.readthedocs.io/en/latest/search.html?q=Operation+and+Workflow&check_keywords=yes&area=default#
- is_ready_for_delete_server() bool[source]#
Check if the configuration is sufficient for deleting server.
See: https://acore-server.readthedocs.io/en/latest/search.html?q=Operation+and+Workflow&check_keywords=yes&area=default#