jina-ai / jcloud

Simplify deploying and managing Jina projects on Jina Cloud
https://docs.jina.ai/concepts/jcloud/
Apache License 2.0
298 stars 13 forks source link

JCloud breaking changes #88

Closed deepankarm closed 1 year ago

deepankarm commented 2 years ago

Jina Version

JCloud uses jina ping command for readiness checks, which was added in jina 3.10.0. So it is compatible with any jina version >=3.10.0.

Changes to JCloud args

  1. spot vs on-demand moved under resources
Before
After
```yaml jtype: Flow executors: - name: executor1 uses: jinahub+docker://Executor1 jcloud: capacity: on-demand ``` ```yaml jtype: Flow executors: - name: executor1 uses: jinahub+docker://Executor1 jcloud: resources: capacity: on-demand ```
  1. expose_gateway is renamed to expose. It is allowed for gateway & executors.
Before
After
```yaml jtype: Flow jcloud: expose_gateway: false executors: - name: custom1 uses: jinahub+docker://CustomExecutor1 - name: custom2 uses: jinahub+docker://CustomExecutor2 ``` ```yaml jtype: Flow jcloud: gateway: expose: false executors: - name: custom1 uses: jinahub+docker://CustomExecutor1 jcloud: expose: true - name: custom2 uses: jinahub+docker://CustomExecutor2 jcloud: expose: true ```
  1. gateway.kind is removed (only Kong Ingress) is allowed.

Changes to jc CLI

  1. --name arg is removed from jc deploy arg list. To pass name to a Flow YAML, please use jcloud.name in the Flow YAML.
Before
After
```bash jc deploy flow.yml --name my-flow-name ``` ```yaml jtype: Flow jcloud: name: my-flow-name executors: - ... ```
  1. Passing environment variables using --env-file is dropped. Users can use env field in the Flow yaml.

  2. jc deploy / jc remove won't show any logs on CI anymore, rather redirect users to the Grafana dashboard.

  3. --status is renamed to --phase in jc list command.

  4. jc logs command dropped.