Local Deployment with SFAI SDK¶

This notebook demonstrates how to deploy applications locally using Docker containers with the SFAI SDK. Local deployment is perfect for development, testing, and quick prototyping.

Overview¶

Local deployment uses Docker to containerize and run your application on your local machine. The platform automatically:

Builds a Docker image from your application
Finds an available port (starting from 8080)
Provides easy access to logs, status, and management commands

Prerequisites¶

Docker installed and running on your system
SFAI SDK installed (pip install sfai)
A Dockerfile in your application directory

Method 1: CLI Workflow¶

Step 1: Initialize Your App¶

This sets the context for your app, all your app config and metadata is stored in context.
Downloades template files for your app deployment.
Initializes the local platform by default.

In [ ]:

  Copied!     
 
!sfai app init
!sfai app init

Step 2: Deploy to Local¶

This builds the Docker image and runs the container.

In [ ]:

  Copied!     
 
!sfai app deploy
!sfai app deploy

Step 3: Open in Browser¶

This opens your application in the default browser.

In [ ]:

  Copied!     
 
!sfai app open
!sfai app open

Step 4: View Logs¶

Check the container logs to see what's happening.

In [ ]:

  Copied!     
 
!sfai app logs
!sfai app logs

Step 5: Check Status¶

Verify if your container is running.

In [ ]:

  Copied!     
 
!sfai app status
!sfai app status

Step 6: View App Context¶

In [ ]:

  Copied!     
 
!sfai app context
!sfai app context

Step 7: Clean Up¶

Stop and remove the container when you're done.

In [ ]:

  Copied!     
 
# Clean up when done (uncomment to run)
!sfai app delete
# Clean up when done (uncomment to run) !sfai app delete

Method 2: Python API Workflow¶

Import Required Modules¶

In [ ]:

  Copied!     
 
from sfai.app import init, get_context
from sfai.app.deploy import deploy
from sfai.app.status import status
from sfai.app.open import open
from sfai.app.logs import logs
from sfai.app.delete import delete
from sfai.app import init, get_context from sfai.app.deploy import deploy from sfai.app.status import status from sfai.app.open import open from sfai.app.logs import logs from sfai.app.delete import delete

Step 1: Initialize App¶

Initialize your app with a template (creates local platform by default).

In [ ]:

  Copied!     
 
init(template="fastapi_hello")
init(template="fastapi_hello")

Step 2: Deploy to Local¶

Deploy your application to the local Docker environment.

In [ ]:

  Copied!     
 
deploy()
deploy()

Step 3: Get Context and URL¶

Get the deployment context to see where your app is running.

In [ ]:

  Copied!     
 
get_context()
get_context()

Step 4: Open in Browser¶

Open your application in the default browser.

In [ ]:

  Copied!     
 
open(path="/invocations")
open(path="/invocations")

Step 5: View Logs¶

Check the container logs.

In [ ]:

  Copied!     
 
logs()
logs()

Optional: Check Status¶

Check if your container is running.

In [ ]:

  Copied!     
 
status()
status()

Optional: Clean Up¶

Stop and remove the container when you're done.

In [ ]:

  Copied!     
 
delete()
delete()

Troubleshooting¶

Check if Docker is Running¶

In [ ]:

  Copied!     
 
!docker ps
!docker ps

Debug Container Issues¶

In [ ]:

  Copied!     
 
# Check logs if container won't start
!sfai app logs

# Check status
!sfai app status
# Check logs if container won't start !sfai app logs # Check status !sfai app status

Check App Context¶

In [ ]:

  Copied!     
 
# Check port and URL
!sfai app context

# Try opening again
!sfai app open
# Check port and URL !sfai app context # Try opening again !sfai app open

Next Steps¶

After successful local deployment, you can:

Deploy to cloud platforms (Heroku, AWS EKS, GCP)
Set up CI/CD pipelines
Configure monitoring and logging

For detailed CLI command options, see CLI Commands Documentation. For cloud deployment guides, see other use case documentation.