Local development server

Local development server

When you need this?¶

For quick tests of Syft functionalities or experimenting with your server setup before deploying, a local development server can be extremely useful. These development servers function like in-memory servers, offering easy launch and tear-down capabilities.

This local development server has its own SQLite storage to keep the server’s metadata and data, and it has the same name as the server’s unique name. If you launch a server with an exsiting storage, that will be loaded together, which means you can use across longer development cycles.

Steps

To deploy a local development server, you only need syft, which comes together with a special module, called orchestra. Via orchestra, you can experiment with a single server deployment or even simulate container workloads.

Installation

Python Version

Please make sure you have Python 3.10+ installed and available.

pip install -U syft

Launch a development server

import syft as sy

server = sy.orchestra.launch(
    name="my_special_server",
    reset=True,
    port=8093,
)

Starting my_special_server server on 0.0.0.0:8093
 Done.
SyftInfo: 
You have launched a development server at http://0.0.0.0:8093.It is intended only for local use.

server.deployment_type

<DeploymentType.PYTHON: 'python'>

The returned object, a sy.ServerHandle, allows fetching specific information about your deployed local server, such as the url or the deployment_type. Here, the deployment type is PYTHON as the server is running in a process in Python. It is good to know that sy.orchestra allows users to experiment with further local containerised deployment as well, but more of this will be covered soon.

Multiple further APIs are available that are also offered on the client, for easy testing, such as register, login_as_guest, etc.

server.url

'http://localhost'

INFO:     Started server process [47430]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
ERROR:    [Errno 48] error while attempting to bind on address ('0.0.0.0', 8093): address already in use
INFO:     Waiting for application shutdown.
INFO:     Application shutdown complete.

server.port

8093

Further arguments can be passed to configure the way you would like to use your development server:

  • dev_mode: True/False, whether you would like verbose logging when using the server for debugging

  • server_type: enclave, domain or gateway

  • server_side_type: high or low, stating whether your server is purposed to host private data (high) or only mock data (low). A high side server is more defensive with how the data is being used.

  • local_db: True/False, whether you would like to initialize a local database or not

  • create_producer: True/False, whether your server can instantiate other in-memory server to simulate working with multiple containers

  • n_consumers: number of in-memory workers simulated, able to consume the workload scheduled. This is required for launching and running jobs and requires create_producer to be True.

  • thread_workers: True/False, whether the in-memory workers should be simulated using threads

  • association_request_auto_approval: True/False, states whether you should auto-approve requests of associating with another server (e.g. routing from one to another)

or from the command line: $ syft launch --name=my-server --port=8080 --reset=True

Access Client and Login

data_owner_client = sy.login(url="localhost:8093", email="[email protected]", password="changethis")
data_owner_client

WARNING:urllib3.connectionpool:Retrying (Retry(total=2, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<urllib3.connection.HTTPConnection object at 0x177f09a60>: Failed to establish a new connection: [Errno 61] Connection refused')': /api/v2/metadata

Stopping process on port: 8093
Process 88115 terminated.

/api/v2/metadata

INFO:     Started server process [17552]
INFO:     Waiting for application startup.
INFO:     Application startup complete.
INFO:     Uvicorn running on http://0.0.0.0:8093 (Press CTRL+C to quit)
WARNING:urllib3.connectionpool:Retrying (Retry(total=1, connect=None, read=None, redirect=None, status=None)) after connection broken by 'NewConnectionError('<urllib3.connection.HTTPConnection object at 0x177f0a030>: Failed to establish a new connection: [Errno 61] Connection refused')': /api/v2/metadata

INFO:     127.0.0.1:51529 - "GET /api/v2/metadata HTTP/1.1" 200 OK
INFO:     127.0.0.1:51529 - "POST /api/v2/login HTTP/1.1" 200 OK
INFO:     127.0.0.1:51529 - "GET /api/v2/api?verify_key=3fd1228a31a8035a433f1ad5fa446c2a92efa0ed32dad2b84ef30d25640c5739&communication_protocol=dev HTTP/1.1" 200 OK
INFO:     127.0.0.1:51530 - "POST /api/v2/api_call HTTP/1.1" 200 OK
Logged into <my_special_server: High side Domain> as <[email protected]>
SyftWarning: 
You are using a default password. Please change the password using `[your_client].me.set_password([new_password])`.

INFO:     127.0.0.1:51531 - "POST /api/v2/api_call HTTP/1.1" 200 OK
Logo

Welcome to my_special_server

URL: http://localhost:8093
Node Type: Domain
Node Side Type:High Side
Syft Version: 0.8.7-beta.13
ⓘ  This domain is run by the library PySyft to learn more about how it works visit github.com/OpenMined/PySyft.

Commands to Get Started

  • <your_client>.projects - list projects
  • <your_client>.requests - list requests
  • <your_client>.users - list users

Landing (shutting down) of the server

server.land()

Stopping my_special_server

INFO:     Shutting down
INFO:     Waiting for application shutdown.
INFO:     Application shutdown complete.
INFO:     Finished server process [17552]

More information on how to use this Datasite server in the Datasite guide and within the components section.

On This Page