diff --git a/docs/source/build.rst b/docs/source/build.rst deleted file mode 100644 index fe88c6ab..00000000 --- a/docs/source/build.rst +++ /dev/null @@ -1,35 +0,0 @@ -Build modules -====================================== - - -Builds on rapyuta.io are a fundamental resource which convert your source code residing in your VCS into a container image. - -Builds can be referenced when creating packages and enables an end-to-end “Code to Deployment” pipeline for your Robotics solution. - - - -.. toctree:: - :maxdepth: 3 - :caption: Contents: - - -Client Module ------------------ - - -.. autoclass:: rapyuta_io.rio_client.Client - :members: __init__, list_builds, create_build, get_build, delete_build, trigger_build, rollback_build - - -Build ------------------ - -.. automodule:: rapyuta_io.clients.build - :members: - :exclude-members: is_ready, poll_till_ready - -Operations on Builds ---------------------- - -.. automodule:: rapyuta_io.clients.buildoperation - :members: \ No newline at end of file diff --git a/docs/source/deployment.rst b/docs/source/deployment.rst deleted file mode 100644 index 8392f0b0..00000000 --- a/docs/source/deployment.rst +++ /dev/null @@ -1,29 +0,0 @@ -Deployment module -====================================== - - -A deployment is a rapyuta.io resource that represents a unique instantiation of a rapyuta.io package. It holds information about the package deployed, the configuration used, and interfaces exposed. It possesses a unique identifier and provides a mechanism to introspect its phase and state that are needed to ascertain the state of a system. - -Tooling such as logs, debug terminals and other automation leverage this uniquely identifiable resource to allow the operator to manage, debug and observe a particular running instance of their application. - -Deployments support composition patterns to allow the user to combine multiple different applications to help realize a potentially more complex robotics solution. - - -.. toctree:: - :maxdepth: 3 - :caption: Contents: - - -Client Module ------------------ - -.. autoclass:: rapyuta_io.rio_client.Client - :members: __init__, get_deployment, get_all_deployments, update_deployment - - - -Deployments Module ------------------------- - -.. automodule:: rapyuta_io.clients.deployment - :members: \ No newline at end of file diff --git a/docs/source/native_network.rst b/docs/source/native_network.rst deleted file mode 100644 index 6f7b9d18..00000000 --- a/docs/source/native_network.rst +++ /dev/null @@ -1,31 +0,0 @@ -Native Network module -====================================== - - -rapyuta.io provides a way to establish robot to robot communication without using brokered solution in a local network. The main purpose of native network is to give the same communication mechanism as present in a single shared ROS master. - - - -.. toctree:: - :maxdepth: 3 - :caption: Contents: - - -Client Module ------------------ - -.. autoclass:: rapyuta_io.rio_client.Client - :members: __init__, list_native_networks, get_native_network, create_native_network, delete_native_network - - - -Native Network Module ------------------------- - -.. automodule:: rapyuta_io.clients.native_network - :members: - :exclude-members: get_deserialize_map,get_serialize_map - -.. autoclass:: rapyuta_io.clients.common_models.InternalDeploymentStatus - :members: - :exclude-members: get_deserialize_map,get_serialize_map diff --git a/docs/source/package.rst b/docs/source/package.rst deleted file mode 100644 index 065ae097..00000000 --- a/docs/source/package.rst +++ /dev/null @@ -1,34 +0,0 @@ -Package module -====================================== - - -A package is a fundamental rapyuta.io resource that represents a declaration of your application. It is the smallest unit of deployment in rapyuta.io, and it can be deployed either on a device or the cloud or both. - -To make this possible a package must encapsulate any information about how it should be built, its compatibility and runtime requirements, network endpoints and ROS interfaces it exposes, and any configuration information it may require. - - - - -.. toctree:: - :maxdepth: 3 - :caption: Contents: - - -Client Module ------------------ - -.. autoclass:: rapyuta_io.rio_client.Client - :members: __init__, get_package, get_all_packages, - create_package, create_package_from_manifest, delete_package - - - -Package Module ------------------------- - -.. automodule:: rapyuta_io.clients.package - :members: - -.. autoclass:: rapyuta_io.clients.plan.Plan - :members: - :exclude-members: get_component_id, get_component_by_name, needs_aliases, validate diff --git a/docs/source/project.rst b/docs/source/project.rst deleted file mode 100644 index 9c06a614..00000000 --- a/docs/source/project.rst +++ /dev/null @@ -1,38 +0,0 @@ -Project module -====================================== - - -Any rapyuta.io resource that you create, or allocate and use must belong to a project. You can think of a project as the organizational unit for what you are building. A project is made up of the settings, configuration, and other metadata that describe your applications. Resources within a single project can work together easily, for example, by communicating through an internal network. The resources that each project contains remain separate across project boundaries; you can only interconnect them through an external connection. - -Each project has: - -- Auto-generated unique project ID -- A project name, which you provide. -- miscellaneous metadata: e.g., creator name, timestamp, etc. -- You may create multiple projects and use them to organize rapyuta.io resources. - - - -.. toctree:: - :maxdepth: 3 - :caption: Contents: - - -.. autosummary:: - :toctree: _autosummary - :template: custom-module-template.rst - :recursive: - -Client Module ------------------ - -.. autoclass:: rapyuta_io.rio_client.Client - :members: __init__, list_projects, create_project,get_project, delete_project, set_project, add_user_to_project, remove_user_from_project - -Project Module ------------------ - -.. automodule:: rapyuta_io.clients.project - :members: - :exclude-members: get_deserialize_map,get_serialize_map - diff --git a/docs/source/routed_network.rst b/docs/source/routed_network.rst deleted file mode 100644 index 11a0866c..00000000 --- a/docs/source/routed_network.rst +++ /dev/null @@ -1,33 +0,0 @@ -Routed Network module -====================================== - - -rapyuta.io implements various features for automatically linking different deployments, and hence, aid software composition. It implements a dedicated communication plane for ROS. - -Routed network is a rapyuta.io resource to enable ROS communication between different ROS package deployments. -Binding a routed network resource to your deployment will enable other deployments on the same routed network to consume ROS topics/services/actions as defined in the package. -Data flow occurs only when another package chooses to subscribe to a topic, call a service or call an action. - - -.. toctree:: - :maxdepth: 3 - :caption: Contents: - - -Client Module ------------------ - -.. autoclass:: rapyuta_io.rio_client.Client - :members: __init__, get_all_routed_networks, get_routed_network, create_cloud_routed_network, create_device_routed_network, delete_routed_network - - - -Routed Network Module ------------------------- - -.. automodule:: rapyuta_io.clients.routed_network - :members: - -.. autoclass:: rapyuta_io.clients.common_models.InternalDeploymentStatus - :members: - :exclude-members: get_deserialize_map,get_serialize_map \ No newline at end of file diff --git a/docs/source/secret.rst b/docs/source/secret.rst deleted file mode 100644 index af2c0a02..00000000 --- a/docs/source/secret.rst +++ /dev/null @@ -1,23 +0,0 @@ -Secret module -====================================== - -A secret is an object containing sensitive information or confidential data such as a password, SSH private key, SSL certificate. -It grants rapyuta.io access to private git repositories and private docker images so that the platform can build source code in private git repositories or use private docker images. - - -.. toctree:: - :maxdepth: 3 - :caption: Contents: - -Client Module ------------------ - -.. autoclass:: rapyuta_io.rio_client.Client - :members: __init__, create_secret,list_secrets,get_secret,delete_secret - - -Secret Module ------------------ -.. automodule:: rapyuta_io.clients.secret - :members: - :exclude-members: get_deserialize_map,get_serialize_map diff --git a/docs/source/static_route.rst b/docs/source/static_route.rst deleted file mode 100644 index 954bcbb8..00000000 --- a/docs/source/static_route.rst +++ /dev/null @@ -1,26 +0,0 @@ -Static Route module -====================================== - - -rapyuta.io enables you to create a static route URL and give it a globally unique FQDN. When you add a static route, an externally exposed endpoint is essentially guaranteed to be available at the URL of that particular static route. It makes externally exposed endpoints (and hence the deployments exposing them) resilient to failure or re-deployment, facilitates maintenance and upgrades to the backend/deployment while retaining the same unique globally available URL. - -Static routes are used frequently to get a deterministic URL/route for your application while exposing the network endpoint externally - -.. toctree:: - :maxdepth: 3 - :caption: Contents: - - -Client Module ------------------ - -.. autoclass:: rapyuta_io.rio_client.Client - :members: __init__, get_all_static_routes, get_static_route, get_static_route_by_name, create_static_route, delete_static_route - - - -Static Route Module -------------------- - -.. automodule:: rapyuta_io.clients.static_route - :members: \ No newline at end of file diff --git a/docs/source/volumes.rst b/docs/source/volumes.rst deleted file mode 100644 index bb6be13e..00000000 --- a/docs/source/volumes.rst +++ /dev/null @@ -1,26 +0,0 @@ -Persistent Volumes -====================================== - -Applications running on the cloud de-allocate any resources consumed when they stop, scale down, or fail. This implies that the working storage associated with them is ephemeral. To get around this problem rapyuta.io provides a mechanism to consume persistent block storage for your applications running in the cloud. This storage can be associated with at most one running deployment at any given point of time. A user is typically required to manage the lifecycle of the application code independently from the associated storage. - -The Rapyuta IO Persistent Volume is a storage package. A storage package is a public package which is available to all users out of the box. You cannot delete or modify storage packages, and they are available to every user. - -.. toctree:: - :maxdepth: 3 - :caption: Contents: - - -Client Module ------------------ - -.. autoclass:: rapyuta_io.rio_client.Client - :members: __init__, get_persistent_volume, get_volume_instance - - - - -Persistent Volumes Module ---------------------------- - -.. automodule:: rapyuta_io.clients.persistent_volumes - :members: \ No newline at end of file