Add a "How to create an instance" example

[quantumsheep]

[d33tah]

Seconding. Is that even possible using this library right now?

[NoSuchCommand]

I guess that, by the time a real InstanceV1API.create_server() method is available, you could rely on InstanceV1API._create_server():

inst._create_server(commercial_type="PRO2-L", image="5cd3faa3-271a-4bba-9e25-fe66f5d34444", enable_ipv6=False)

Note that image= requires the UUID of the local-image of the target zone, given by the MarketplaceV2API.

[kinoute]

Still no news on this? Got a lot of errors trying to do so... Creating and starting a instance is a must have.

Failed to create instance: VolumeServer.__init__() missing 6 required positional arguments: 'name', 'organization', 'size', 'state', 'project', and 'zone'

            instance = instance_api._create_server(
                project=project_id,
                organization=organization_id,
                name=instance_name,
                enable_ipv6=False,
                dynamic_ip_required=True,
                commercial_type='DEV1-S', 
                image='docker'
            )

[Laure-di]

Hi @kinoute,

You can use the master branch to fix the issue; it should be fixed for good in the next release.

We are currently working on the instance documentation.

Thank you very much,

Have a nice day

[feluxe]

I just ran into this myself. I was searching the source API docs for a while and found it very confusing that there are "create" functions for everything except "create_instance". It took me a while to find this issue here on GitHub.

Something like this in class InstanceV1API(API) would help:

def create_instance():
    """
    This function is not yet implemented. Please use `_create_instance` for now.
    More info: https://github.com/scaleway/scaleway-sdk-python/issues/280
    """
    raise NotImplementedError(__doc__)

[Laure-di]

Hello @feluxe 👋

You can create an instance server using the following snippet:

instance_api = InstanceUtilsV1API(client, bypass_validation=True)
   block_api = BlockV1Alpha1API(client, bypass_validation=True)
   volumes_list: list[Volume] = []

   volumes = {
       "0": VolumeServerTemplate(
           volume_type=VolumeVolumeType.L_SSD,
           size=volume_size,
           boot=False,
       )
   }

   instance = instance_api.create_server(
       commercial_type=commercial_type,
       zone=zone,
       name=server_name,
       dynamic_ip_required=False,
       volumes=volumes,
       protected=False,
       boot_type=BootType.LOCAL,
       image="c00ae53c-1e29-4087-a384-47f3c5c1cd84",
   )

Regarding the documentation — we’re currently working on an updated version that will include clearer examples and explanations.