Download the PHP package utopia-php/orchestration without Composer
On this page you can find all versions of the php package utopia-php/orchestration. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download utopia-php/orchestration
More information about utopia-php/orchestration
Files in utopia-php/orchestration
Package orchestration
Short Description Lite & fast micro PHP abstraction library for container orchestration
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package orchestration
Utopia Orchestration
Utopia framework orchestration library is simple and lite library for abstracting the interaction with multiple container orchestrators. This library is aiming to be as simple and easy to learn and use. This library is maintained by the Appwrite team.
Although this library is part of the Utopia Framework project it is dependency free and can be used as standalone with any other PHP project or framework.
Getting Started
Install using composer:
Example
Usage
Initialisation
There are currently two orchestrator adapters available and each of them has slightly different parameters:
-
DockerAPI
Directly communicates to the Docker Daemon using the Docker UNIX socket.
$username, $password and $email are optional and are only used to pull private images from Docker Hub.
-
DockerCLI
Uses the Docker CLI to communicate to the Docker Daemon.
$username and $password are optional and are only used to pull private images from Docker Hub.
Once you have initialised your Orchestration object the following methods can be used:
-
Pulling an image
This method pulls the image requested from the orchestrators registry. It will return a boolean value indicating if the image was pulled successfully.
Parameters
- `image` [String] [Required] The image to pull from the registry. -
Running a container
This method creates and runs a new container. On success, it will return a string containing the container ID. On failure, it will throw an exception.
Parameters
- `image` [String] [Required] The image to base the container off. - `name` [String] [Required] The name given to the container. - `command` [Array] The command to run in the container seperated into a array. - `entrypoint` [String] The executable to run in the container. - `workdir` [String] The default directory in which the container commands will run. - `volumes` [Array] The volumes to attach to the container. - `env` [Array] The environment variables to set in the container. - `mountFolder` [String] A folder that will be automatically mounted to /tmp in the container - `labels` [Array] The labels to set on the container. - `hostname` [String] The hostname to set on the container. - `remove` [Boolean] Whether to remove the container once it exits. -
Executing a command in a running container
This method executes a command in an already running container and returns a boolean value indicating if the command was executed successfully.
Parameters
- `container_id` [String] [Required] The ID of the container to execute the command in. - `command` [Array] [Required] The command to execute in the container. - `stdout` [String] [Reference] The variable to store the stdout of the command in. - `stderr` [String] [Reference] The variable to store the stderr of the command in. - `env` [Array] The environment variables to set while executing the command. - `timeout` [Integer] The timeout in seconds to wait for the command to finish. -
Removing a container
This method removes a container and returns a boolean value indicating if the container was removed successfully.
Parameters
- `container_id` [String] [Required] The ID of the container to remove. - `force` [Boolean] Whether to remove the container forcefully. -
List containers
This method returns an array of containers.
Parameters
- `filters` [Array] Filters to apply to the list of containers. -
List Networks
This method returns an array of networks.
Parameters
This method has no parameters -
Create a Network
This method creates a new network and returns a boolean value indicating if the network was created successfully.
Parameters
- `name` [String] [Required] The name of the network. - `internal` [Boolean] Whether to set the network to be an internal network. -
Remove a Network
This method removes a network and returns a boolean value indicating if the network was removed successfully.
Parameters
- `network_id` [String] [Required] The ID of the network to remove. -
Connect a container to a network
This method connects a container to a network and returns a boolean value indicating if the connection was successful.
Parameters
- `container_id` [String] [Required] The ID of the container to connect to the network. - `network_id` [String] [Required] The ID of the network to connect to. -
Disconnect a container from a network
This method disconnects a container from a network and returns a boolean value indicating if the removal was successful.
Parameters
- `container_id` [String] [Required] The ID of the container to disconnect from the network. - `network_id` [String] [Required] The ID of the network to disconnect from. - `force` [Boolean] Whether to disconnect the container forcefully.
System Requirements
Utopia Framework requires PHP 7.3 or later. We recommend using the latest PHP version whenever possible.
Copyright and license
The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php
