Simplify deploying and managing Jina projects on Jina Cloud
Project description
Simplify deploying and managing Jina projects on Jina Cloud
☁️ To the cloud! - Smoothly deploy a local project as a cloud service. Radically easy, no brainfuck.
🎯 Cut to the chase - One CLI with five commands to manage the lifecycle of your Jina projects.
🎟️ Early free access - Sneak peek at our steathy cloud hosting platform. Built on latest cloud-native tech stack to host your Jina project and offer computational and storage resources. And it is free for now!
Install
pip install jcloud
jc -h
Get Started
Login
jc login
You can use Google/Github account to register and login. Without login, you can do nothing.
Deploy a Jina Flow
In Jina's idiom, a Flow is a project. A Flow represents an end-to-end task such as indexing, searching, recommending, etc. In the sequel, we will use "project" and "Flow" interchangeably.
Deploy a single YAML Flow
A Jina Flow can be as simple as a single YAML file, representing a Flow with all configs and executors in it. The simplest toy.yml looks like the following:
jtype: Flow
executors: {}
To make a single-YAML Flow in practice, it requires all Executors to be specified with uses: jinahub+docker://MyExecutor or uses: docker://your_dockerhub_org/MyExecutor. No more file dependency. The YAML itself is self-contained.
To deploy it:
jc deploy toy.yml
Flow is succefully deployed when you see:
You will get an Flow ID, say 84b8b495df. This ID is required to manage, view logs and remove the Flow.
As this Flow is deployed with default gRPC gateway, you can use jina.Client to access it:
from jina import Client, Document
c = Client(host='grpcs://84b8b495df.wolf.jina.ai')
print(c.post('/', Document(text='hello')))
Deploy a Flow from a folder
You can also deploy a Jina Flow from a local folder:
jc deploy /my/folder
Note that /my/folder must contain a flow.yml that represents the Flow. Besides, it can contain sub-folders of Executor implementations. You can create an example project folder via jc new.
View logs
jc logs 84b8b495df
Remove a Flow
jc remove 84b8b495df
Get the status of a Flow
jc status 84b8b495df
List all Flows on the cloud
jc list
You can only see the Flows deployed by you.
Support
- Check out the Learning Bootcamp to get started with DocArray.
- Join our Slack community and chat with other community members about ideas.
- Join our Engineering All Hands meet-up to discuss your use case and learn Jina's new features.
- When? The second Tuesday of every month
- Where? Zoom (see our public events calendar/.ical) and live stream on YouTube
- Subscribe to the latest video tutorials on our YouTube channel
Join Us
JCloud is backed by Jina AI and licensed under Apache-2.0. We are actively hiring AI engineers, solution engineers to build the next neural search ecosystem in open-source.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
