- setup - create/manage cellery runtime installations.
- init - initialize a cellery project.
- build - build a cell image.
- run - create cell instance(s).
- view - view cell and component dependencies.
- list - list information about cell instances/images.
- delete - Delete cell images.
- login - login to cell image repository.
- push - push a built image to cell image repository.
- pull - pull an image from cell image repository.
- terminate - terminate a cell instance.
- status - check status of cell instance.
- logs - display logs of one/all components of a cell instance.
- inspect - list the files included in a cell image.
- extract-resources - extract packed resources in a cell image.
- update - perform a patch update on a particular cell instance.
- route-traffic - route a percentage of traffic to a new cell instance.
- export-policy - export a policy from cellery run time.
- apply-policy - apply a policy to a cellery instance.
Cellery setup command install and manage cellery runtimes. For this purpose it supports several sub commands. Please refer the setup command readme for complete instructions.
Display status of cluster with a status list of system components
Ex:
cellery setup status
This will initialize a new cellery project in the current directory with the given name which includes an auto-generated cell definition. The project name also can be provided as inline param which will initialize the cellery project as given.
Ex:
cellery init
cellery init my-first-project
Build an immutable cell image.
- Cell file: The .bal which has the cell definition
- Cell image name: This is the image name, and it should be in format <ORGANIZATION_NAME>/<IMAGE_NAME>:<VERSION>
Ex:
cellery build my-project.bal wso2/my-cell:1.0.0
Create a running instance from a cell image.
- Cell image name: name of a built Cell image
- -y, --assume-yes : Flag to enable/disable prompting for confirmation before starting instance(s)
- -e, --env : Set an environment variable for the cellery run method in the Cell file
- -l, --link : Link an instance with a dependency alias
- -n, --name : Name of the cell instance
- -s, --share-instances : Share all instances among equivalent Cell Instances
- -d, --start-dependencies : Start all the dependencies of this Cell Image in order
Ex:
cellery run wso2/my-cell:1.0.0
cellery run wso2/my-cell:1.0.0 -n my-cell-inst
cellery run wso2/my-cell:1.0.0 -l dependencyKey:dependentInstance
cellery run wso2/my-cell:1.0.0 -e config=value
cellery run wso2/my-cell:1.0.0 -d
cellery run wso2/my-cell:1.0.0 -s -d
cellery run wso2/my-cell:1.0.0 -y
View the cell image with inter component dependencies, and inter cell dependencies.
cellery view wso2/my-cell:1.0.0
List running instances/cell images. This command can take four forms, for listing components, images, ingresses or instances.
List the components which the cell image/instance encapsulate.
- cell instance name/cell image name: Either the cell instance name and cell image name.
Ex:
cellery list components my-cell-inst
cellery list components cellery-samples/employee:1.0.0
Lists the available cell images.
Ex:
cellery list images
List the exposed APIs of a cell image/instance.
- cell instance name/cell image name: Either the cell instance name and cell image name.
Ex:
cellery list ingresses my-cell-inst
cellery list ingresses cellery-samples/employee:1.0.0
List all running cells.
Ex:
cellery list instances
List the dependency information for a given cell instance. The dependency cell image, version and the cell instance name will be provided as the output.
- cell instance name: A valid cell instance name.
Ex:
cellery list dependencies my-cell-inst
Delete cell images. This command will delete one or more cell images from cellery local repository. Users can also delete all cell images by executing the command with "--all" flag.
- cell image names: This is a space separated list of existing cell images and/or regular expression of cell images.
Ex:
cellery delete cellery-samples/employee:1.0.0 cellery-samples/hr:1.0.0
cellery delete --regex 'cellery-samples/.*:1.0.0'
cellery delete cellery-samples/employee:1.0.0 --regex '.*/employee:.*'
cellery delete --all
Log in the user to the cellery image repository, which is docker hub, and caches the credentials in the key ring in their machine, therefore user doesn't need to repeat typing the credentials.
Ex:
cellery login
Push the cell image to the docker hub user account.
- cell image name: This is the image name, and it should be in format <ORGANIZATION_NAME>/<IMAGE_NAME>:<VERSION>
Ex:
cellery push wso2/my-cell:1.0.0
Pull the cell image from docker registry and include in the cellery local repository.
- cell image name: This is the image name, and it should be in format <ORGANIZATION_NAME>/<IMAGE_NAME>:<VERSION>
Ex:
cellery pull wso2/my-cell:1.0.0
Terminate running cell instances within cell runtime.
- cell instance names: Names of the instances running in the cellery system
Ex:
cellery terminate employee
cellery terminate pet-fe pet-be
cellery terminate --all
Check for the runtime status of the cell instance.
- cell instance name: Name of the instance running in the cellery system
Ex:
cellery status my-cell-inst
Fetch logs of all components or specific component within the cell instance and print in the console.
- cell instance name: Name of the instance running in the cellery system
- -c, --component: Name of the component of which the logs are required
Ex:
cellery logs my-cell-inst
cellery logs my-cell-inst -c my-comp
List the files included in a cell image.
- cell image name: This is the image name, and it should be in format <ORGANIZATION_NAME>/<IMAGE_NAME>:<VERSION>
Ex:
cellery inspect wso2/my-cell:1.0.0
This will extract the resources folder of the cell image. This is useful to see the swagger definitions of the cell APIs therefore users can generate client code to invoke the cell APIs.
- cell image name: This is the image name, and it should be in format <ORGANIZATION_NAME>/<IMAGE_NAME>:<VERSION>
- -o, --output: The directory into which the resources should be extracted
Ex:
cellery extract-resources wso2/my-cell:1.0.0
cellery extract-resources wso2/my-cell:1.0.0 -o /my/output/resource
Perform a patch update on a running cell instance, using the new cell image provided. This is done as a rolling update, hence only changes to docker images encapsulated within components will be applied.
- cell instance name: The name of a running cell instance, which should be updated.
- cell image name: The name of the new cell image, which will be used to perform a rolling update on the running instance's components.
Ex:
cellery update myhello cellery/sample-hello:1.0.3
This is used to direct a percentage of traffic originating from one cell instance to another. This command is used in advanced deployment patterns such as Blue-Green and Canary.
- existing dependency instance: Existing dependency instance, which is currently recieving 100% traffic from the relevane source instance(s).
- -p, --percentage: The new dependency instance and the percentage of traffic which should be routed to it, joined by a '=' sign.
- -s, --source: The source instance which is generating traffic for the dependency instance specified in the Parameters above. If this is not given all instances which are currently depending on the provided dependency instance will be considered.
Ex:
cellery route-traffic --source hr-client-1 hr-inst-1 --percentage hr-inst-2=20
cellery route-traffic hr-inst-1 --percentage hr-inst-2=100
Export a policy from the Cellery runtime as a file system artifact. This can be either exported to a file specified by the CLI user, or a file starting with cell instance name.
Export a set of autoscale policies which is applicable to a given cell instance.
- cell instance name: A valid cell instance name.
- -f, --file: File name to which the autoscale policy should be exported.
Ex:
cellery export-policy autoscale mytestcell1 -f myscalepolicy.yaml
cellery export-policy autoscale mytestcell1
Apply a policy/set of policies included in a file to the Cellery runtime targeting a running cell instance.
Apply a file containing a set of autoscale policies to the given cell instance.
- autoscale policy file: A file containing a valid autoscale policy/set of autoscale policies.
- instance name: The target instance to which the autoscale policies should be applied.
- -c, --components: Comma separated list of components of the provided instance, to which the autoscale policy should be applied.
- -g, --gateway: Flag to indicate that the given autoscale policy should be applied to only the gateway of the target instance.
Ex:
cellery apply-policy autoscale myscalepolicy.yaml myinstance --components comp1,comp2
cellery apply-policy autoscale myscalepolicy.yaml myinstance --gateway
cellery apply-policy autoscale myscalepolicy.yaml myinstance
type: AutoscalePolicy
rules:
- overridable: true
policy:
maxReplicas: 4
metrics:
- resource:
name: cpu
targetAverageUtilization: 40
type: Resource
minReplicas: "1"
target:
name: controller
type: component
---
type: AutoscalePolicy
rules:
- overridable: false
policy:
maxReplicas: 2
metrics:
- resource:
name: cpu
targetAverageUtilization: 50
type: Resource
minReplicas: "1"
target:
type: gateway
---- If the target type is specified as 'component', that implies that the policy should be applied to the component denoted by the target name.
- If the target type is 'gateway' it should be applied to the gateway of the relevant cell instance.
- The flag 'overridable' implies whether the existing policy can be overriden by the same command repeatedly.