This project will no longer be maintained by Intel.
This project has been identified as having known security escapes.
Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.
Intel no longer accepts patches to this project.
Note: The development of CloudTik has been moved to https://github.com/cloudtik/cloudtik.
Building and operating fully distributed and high performance data analytics and AI platform are complex and time-consuming. This is usually hard for small or middle enterprises not saying individuals.
While the existing solutions for solving distributed analytics and AI problems on cloud have major challenges on a combination of various aspects cared by users. These include high cost for software services, non-optimal performance on the corresponding hardware, the complexity of operating and running such a platform and lack of transparency.
CloudTik enables researchers, data scientists, and enterprises to easily create and manage analytics and AI platform on public clouds, with out-of-box optimized functionalities and performance, and to go quickly to focus on running the business workloads in hours or in even minutes instead of spending months to construct and optimize the platform.
CloudTik is designed for solving the above challenges by providing a platform to help user focuses on business development and achieve "Develop once, run everywhere" with the following core capabilities:
- Scalable, robust, and unified control plane and runtimes for all environments:
- Public cloud providers and Kubernetes
- Single node virtual clustering
- Local or on-premise clusters
- Out of box optimized runtimes for storage, database, analytics and AI
- Optimized Spark runtime with CloudTik optimizations
- Optimized AI runtime with Intel oneAPI
- Infrastructure and runtimes to support microservices orchestration with:
- Service discovery - service registry, service discover, service DNS naming
- Load balancing - Layer 4 or Layer 7 load balancer working with built-in service discovery
- Support of major public cloud providers:
- AWS - Amazon Elastic Compute Cloud (EC2) or Amazon Elastic Kubernetes Service (EKS)
- Azure - Azure Virtual Machines or Azure Kubernetes Service (AKS)
- GCP - Google Compute Engine (GCE) or Google Kubernetes Engine (GKE)
- Alibaba Cloud - Elastic Compute Service (ECS)
- Kubernetes and more
- A fully open architecture and open-sourced platform
Workspace is the CloudTik concept to act as the container of a set of clusters and the shared Cloud resources among these clusters.
When a workspace for specific cloud provider is created, all the shared resources for implementing the unified design are created. These include network resources (like VPC, subnets, NAT gateways, firewall rules), instance profiles, cloud storage and so on. Although the actual resources varies between cloud providers while the design the resources achieved is consistent.
Within a workspace, one or more clusters with needed services(runtimes) can be started. These clusters will share a lot of common configurations such as network (they are in the same VPC) but vary on other aspects including instance types, scale of the cluster, services running and so on. The services provided by one cluster can be discovered by other clusters and be consumed.
CloudTik provider abstracts the hardware infrastructure layer so that CloudTik common facilities and runtimes can consistently run on every provider environments. The support of different public cloud are implemented as providers (such as AWS, Azure, GCP providers). Beyond the public cloud environments, we also support virtual single node clustering, local or on-premise clusters which are also implemented as providers (for example, virtual, local and on-premise providers)
For each cluster started, user can configure very easily which runtimes (such as Spark runtime or Machine Learning/Deep Learning runtime) are needed. CloudTik has designed the runtimes with the optimized configurations and libraries. And when the cluster is running, the runtimes are properly configured and ready for running your workload.
CloudTik requires a Python environment on Linux. We recommend using Conda to manage Python environments and packages.
If you don't have Conda installed, please refer to dev/install-conda.sh to install Conda on Linux.
git clone https://github.com/oap-project/cloudtik.git && cd cloudtik
bash dev/install-conda.sh
Once Conda is installed, create an environment with a specific Python version as below. CloudTik currently supports Python 3.8 or above. Take Python 3.9 as an example,
conda create -n cloudtik -y python=3.9
conda activate cloudtik
Execute the following pip commands to install CloudTik on your working machine for specific cloud providers.
Take AWS for example,
pip install cloudtik[aws]
Replace cloudtik[aws] with clouditk[azure], cloudtik[gcp], cloudtik[aliyun]
if you want to create clusters on Azure, GCP, Alibaba Cloud respectively.
If you want to run on Kubernetes, install cloudtik[kubernetes].
Or clouditk[eks] or cloudtik[gke] if you are running on AWS EKS or GCP GKE cluster.
Use cloudtik[all] if you want to manage clusters with all supported Cloud providers.
If you don't have a public cloud account, you can also play with CloudTik easily locally with the same clustering experiences using virtual, on-premise or local providers. For this case, simply install cloudtik core as following command,
pip install cloudtik
Please refer to User Guide: Running Clusters Locally for detailed guide for this case.
After CloudTik is installed on your working machine, you need to configure or log into your Cloud account to authenticate the cloud provider CLI on this machine.
First, install AWS CLI (command line interface) on your working machine. Please refer to Installing AWS CLI for detailed instructions.
After AWS CLI is installed, you need to configure AWS CLI about credentials. The quickest way to configure it
is to run aws configure command, and you can refer to
Managing access keys
to get AWS Access Key ID and AWS Secret Access Key.
More details for AWS CLI can be found in AWS CLI Getting Started.
After CloudTik is installed on your working machine, login to Azure using az login.
Refer to Sign in with Azure CLI for more details.
If you use service account authentication, follow Creating a service account to create a service account on Google Cloud.
A JSON file should be safely downloaded to your local computer, and then set the GOOGLE_APPLICATION_CREDENTIALS environment
variable as described in the Setting the environment variable
on your working machine.
If you are using user account authentication, refer to User Guide: Login to Cloud for details.
The simple way to set up Alibaba Cloud credentials for CloudTik use is to export the access key ID and access key secret of your cloud account:
export ALIBABA_CLOUD_ACCESS_KEY_ID=xxxxxxxxxxxxxxxxxxxxxxxx
export ALIBABA_CLOUD_ACCESS_KEY_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
For more options of Alibaba Cloud credentials configuration in CloudTik, refer to User Guide: Login to Cloud.
Note: please activate OSS through Alibaba Cloud Console before going to the next step.
If you are running CloudTik on a generic Kubernetes cluster, the authentication setup is simple. You just need to authenticate your kubectl at your working machine to be able to access the Kubernetes cluster.
If you are running cloud Kubernetes engine (such as AWS EKS, GCP GKE or Azure AKE) with cloud integrations with access to cloud resources such as cloud storage, you need both kubectl authentication to cloud Kubernetes cluster and cloud API credentials configuration above.
For detailed information of how configure Kubernetes with cloud integrations, refer to User Guide: Login to Cloud - Kubernetes
Once you authenticated with your cloud provider, you can start to create a Workspace.
CloudTik uses Workspace concept to easily manage shared Cloud resources such as VPC network resources, identity and role resources, firewall or security groups, and cloud storage resources. By default, CloudTik will create a workspace managed cloud storage (S3 for AWS, Data Lake Storage Gen 2 for Azure, GCS for GCP) for use without any user configurations.
Note: Some resources like NAT gateway or elastic IP resources in Workspace cost money. The price policy may vary among cloud providers. Please check the price policy of the specific cloud provider to avoid undesired cost.
Within a workspace, you can start one or more clusters with different combination of runtime services.
Create a configuration workspace yaml file to specify the unique workspace name, cloud provider type and a few cloud provider properties.
Take AWS for example,
# A unique identifier for the workspace.
workspace_name: example-workspace
# Cloud-provider specific configuration.
provider:
type: aws
region: us-west-2
# Use allowed_ssh_sources to allow SSH access from your client machine
allowed_ssh_sources:
- 0.0.0.0/0
NOTE: 0.0.0.0/0 in allowed_ssh_sources will allow any IP addresses to connect to your cluster as long as it has the cluster private key.
For more security, you need to change from 0.0.0.0/0 to restricted CIDR ranges for your case.
Use the following command to create and provision a Workspace:
cloudtik workspace create /path/to/your-workspace-config.yaml
Check Configuration Examples folder for more Workspace configuration file examples for AWS, Azure, GCP, Kubernetes (AWS EKS or GCP GKE).
If you encounter problems on creating a Workspace, a common cause is that your current login account for the cloud doesn't have enough privileges to create some resources such as VPC, storages, public ip and so on. Make sure your current account have enough privileges. An admin or owner role will give the latest chance to have all these privileges.
Now you can start a cluster running Spark by default:
cloudtik start /path/to/your-cluster-config.yaml
A typical cluster configuration file is usually very simple thanks to design of CloudTik's templates with inheritance.
Take AWS for example,
# An example of standard 1 + 3 nodes cluster with standard instance type
from: aws/standard
# Workspace into which to launch the cluster
workspace_name: example-workspace
# A unique identifier for the cluster.
cluster_name: example
# Cloud-provider specific configuration.
provider:
type: aws
region: us-west-2
auth:
ssh_user: ubuntu
# Set proxy if you are in corporation network. For example,
# ssh_proxy_command: "ncat --proxy-type socks5 --proxy your_proxy_host:your_proxy_port %h %p"
available_node_types:
worker.default:
# The minimum number of worker nodes to launch.
min_workers: 3
This example can be found in CloudTik source code folder examples/cluster/aws/example-standard.yaml.
You need only a few key settings in the configuration file to launch a Spark cluster.
As for auth above, please set proxy if your working node is using corporation network.
auth:
ssh_user: ubuntu
ssh_proxy_command: "ncat --proxy-type socks5 --proxy <your_proxy_host>:<your_proxy_port> %h %p"
The cluster key will be created automatically for AWS and GCP if not specified.
The created private key file can be found in .ssh folder of your home folder.
For Azure, you need to generate an RSA key pair manually (use ssh-keygen -t rsa -b 4096 to generate a new ssh key pair).
and configure the public and private key as following,
auth:
ssh_private_key: ~/.ssh/my_cluster_rsa_key
ssh_public_key: ~/.ssh/my_cluster_rsa_key.pub
If you need different runtime components in the cluster, in the cluster configuration file, you can set the runtime types. For example,
runtime:
types: [spark, ai]
It will run a cluster with spark and AI runtimes.
Refer to examples/cluster directory for more cluster configurations examples.
Once the cluster is started, you can run Spark analytics and AI workloads which are designed to be distributed and large scale in nature.
Below provides the information of some basic examples to start with. As to running optimized Spark and AI, you can refer to Running Optimized Analytics with Spark and Running Optimized AI for more information.
Running a Spark job is very straight forward. Spark PI job for example,
cloudtik exec ./your-cluster-config.yaml "spark-submit --master yarn --deploy-mode cluster --name spark-pi --class org.apache.spark.examples.SparkPi --conf spark.yarn.submit.waitAppCompletion=false \$SPARK_HOME/examples/jars/spark-examples.jar 12345" --job-waiter=spark
Refer to Run Spark PI Example for more details.
CloudTik provides ready to use tools for running TPC-DS benchmark on a CloudTik spark runtime cluster.
Refer to Run TPC-DS performance benchmark for Spark for a detailed step-by-step guide.
CloudTik provides ready to run examples for demonstrating how distributed AI jobs can be implemented in CloudTik Spark and AI runtime cluster.
Refer to Distributed AI Examples for a detailed step-by-step guide.
User can integrate CloudTik with external workflows using bash scripts or python for running on-demand cluster and jobs.
Refer to Workflow Integration Examples for example scripts.
CloudTik provides very powerful capability to monitor and manage the cluster.
Use the following commands to show various cluster information.
# Check cluster status with:
cloudtik status /path/to/your-cluster-config.yaml
# Show cluster summary information and useful links to connect to cluster web UI.
cloudtik info /path/to/your-cluster-config.yaml
cloudtik head-ip /path/to/your-cluster-config.yaml
cloudtik worker-ips /path/to/your-cluster-config.yaml
Connect to a terminal of cluster head node.
cloudtik attach /path/to/your-cluster-config.yaml
Execute a command via SSH on cluster head node or a specified node.
cloudtik exec /path/to/your-cluster-config.yaml [command]
Upload files or directories to cluster.
cloudtik rsync-up /path/to/your-cluster-config.yaml [source] [target]
Download files or directories from cluster.
cloudtik rsync-down /path/to/your-cluster-config.yaml [source] [target]
Stop and delete the cluster.
cloudtik stop /path/to/your-cluster-config.yaml
Delete the workspace and all the network resources within it.
cloudtik workspace delete /path/to/your-workspace-config.yaml
Be default, the managed cloud storage will not be deleted. Add --delete-managed-storage option to force deletion of manged cloud storage.
For more information as to the commands, you can use cloudtik --help or cloudtik [command] --help to get detailed instructions.