- Introduction to IOx
- IOx Edge Compute Devices
- IC3000-series
- IR 800-series
- IR 1100 Series
- IE 4000-series
- IE3x00 Series
- IE93xx Series
- CGR 1000 Compute Module
- ISR 800-series
- Catalyst 9000-series
- ISR 4000/ASR 1000-series
- Comparison of IOx Devices
- IOx Resource Downloads
- IOx Local Manager
- IOx Development Tools
- ioxclient Reference
- What is ioxclient?
- Profiles
- App management
- App file management
- App console
- Service management
- Platform management
- Getting CAF Metrics
- Manage devices
- Managing logical networks
- Manage platform log files
- Manage package signature validation
- Debuggability and Diagnostics
- Platform Certificates
- Smart License Management
- Cartridge management
- Messaging service
- Docker commands
- Docker Layers
- Docker Toolchain Setup
- ioxclient Reference
- IOx App Tutorials
- Docker Applications
- Overview
- Tutorial: Deploy Dockerhub Image
- Tutorial: Create Custom Package Descriptor for Docker Apps
- Tutorial: Build Sample Docker Type IOx app Using Docker Toolchain
- Tutorial: Build Sample Docker Type Python Simple App
- Tutorial: Build Sample Docker Type C Based Simple App
- Tutorial: Build Sample Docker Type Python with C App
- Tutorial:Build Sample Docker Type C++ Based Simple App
- Tutorial: Build Sample Docker Type nodejs Based HTTP Server Using Alpine Base Image
- Tutorial: Build Sample Docker Type IOx App That Consumes GPS Service
- VM Applications
- Legacy Styles
- Docker Applications
- IOx App Concepts
- Advanced Features
- Application Groups
- Remote Docker workflow
- OVA to IOx VM App Package Deployment
- Debuggability and Diagnostics
- USB Storage and Serial Device
- IOx Services
- Key Value Datastore
- Cisco Local Manager Based App Console Access
- Fog Director API Documentation
- IOx Smart Licensing
- Access GPS data from an IOx App via serial interface on IR1101
- Troubleshooting Guide
- Developer Resources
- Community and Support
Tutorial: Deploy Dockerhub Image on IOx using Local Manager
In this tutorial, we will go through a quick start guide about how to deploy a Docker image on Dockerhub to IOx enabled Cisco Edge Compute device using inbuilt web sever called Local Manager.
Requirements
- PC/Laptop with connectivity to public Dockerhub registry
- Docker daemon up and running on PC/Laptop
Save Dockerhub Image
We will use nginx Docker image on Dockerhub for this tutorial. You can deploy any other Dockerhub image as needed for your desired platform's CPU architecture. Pulling the Docker image directly from an IOx enabled Cisco platform is not supported. Therefore, we need to pull the Docker image on PC/Laptop and save the Docker image as tar archive as shown below.
We have saved Dockerhub nginx Docker image as an nginx.tar archive on the local PC/Laptop.
Deploy Docker Image
We will have an IOx infra automatically generate a package descriptor (package.yaml) of the Docker app from the Docker image. Therefore, we don't need to create a package descriptor file (unless any custom changes are needed). Also, we don't have to convert the Docker image into an IOx package format.
Note: IOx infra by default sets up one container network interface for Docker images deployed without explicit package.yaml definition.
Use IOx Local Manager (LM) to deploy the saved Docker image tar archive as an IOx application. Ensure you have completed the following prerequisites for this step:
- The Cisco platform is configured as described under the respective Platform section
- The HTTPS server is accessible via the external interface.
On platforms running Cisco IOS-XE, access the LM at https://your-external-mgmt-ip-address/iox/login. For other platforms, access the LM at https://your-external-mgmt-ip-address:8443.
1. Upload Docker Image
We will use the Cisco IC3000 platform for deploying the nginx Docker application.
- Access the IC3000 LM at https://your-external-mgmt-ip-address:8443.
- Upload the saved nginx tar archive directly to LM.
- Verify that the nginx Docker app is uploaded to the device.
2. Allocate Runtime Resources and Start Container
Allocate resources such as CPU, memory, network, and disk for the Docker container by activating the app.
- Click the activate button on the nginx widget to view the resources available on the platform.
Available resources are different across Cisco platforms. Refer to section Platform Matrix for comparisons of resources available for IOx App hosting infra.
We can add or override a Docker container configuration (for example, environment variables, entry points, and so forth) by providing runtime options under Advance Settings->Docker Options. Specify options exactly how they will be used in the Docker run command, separated by spaces.
The networking configuration available for IOx apps is different across routing, switching, and computing platforms. Refer to the respective platform deployment guide here for how to configure external connectivity to the IOx application.
The IC3000 platform supports pre-configured internal private network (iox-docker-nat0), pre-configured management interface network (iox-bridge0), and data interfaces network for the applications.
Use an internal private network for nginx Docker app and expose the web server on a custom external tcp port 8080. Configure this external custom port mapping by clicking edit and then Port Mapping in the Network configuration section.
Select the custom radio button, and enter External TCP port as 8080. Click OK in Network configuration to complete network setup.
- Click Activate for allocating the configured resources to the nginx Docker app.
- Go back to the home page by clicking Applications in top tabs hierarchy, and start the nginx app.
- Access the nginx web server running inside a Docker container on IC3000 at https://your-external-mgmt-ip-address:8080.
