Skip to main content
Version: v2.0.0

Concepts

general General​

Account​

Represents a user in the system.

Alert​

A notification or warning to inform users about specific events or issues that require their attention.

CLI​

Managing Cuemby Platform from the terminal.

Cluster​

A collection of machines.

Type: Control plane of runtime nodes.

  • Control plane (main node): They are machines that run K8S of the master type. Users do not have access to these machines.
  • Runtime nodes (worker node): It is the place where applications created by users or managed services are run.

Email verification​

If you forget your password, a verification email will be sent to your registered email address to reset it.

  • Privacy policy: A legal document outlining how an organization collects, processes, retains, and manages user data.
  • Terms of use: Legal contract between Cuemby (the service provider) and the user outlining the terms and conditions for using the service.

Notification​

A push message that is displayed on the platform according to what is configured by the user.

Quick Start​

Short instructions and explanations designed to help users quickly understand and use a particular feature or topic.

Report a Bug​

A detailed report of an error found in the platform, including a title, description and an optional image attachment.

profile-info Profile Information​

User’s personal information and preference settings within Cuemby Platform.

orgs Organizations​

A person or group of people managing projects and resources within the platform.

projects Project​

A workspace within the platform that allows teams to collaborate on deploying applications. A project may contain multiple users with assigned roles and permissions.

api-keys API Key​

Short instructions and explanations designed to help users quickly understand and use a particular feature or topic.

Expiration date​

The duration of the API Key’s validity, which can be modified by the user.

Enable/Disable​

Users can activate or deactivate the API Key to enhance security.

user User​

A user belongs to an organization and they can realize actions according to their role and permissions.

Cancel invitation​

It allows to cancel an invitation if the user is new in Cuemby Platform and they have not logged in to the platform.

Invitation expired​

Invitation to a user expires if they do not log in to Cuemby Platform to collaborate in an organization in 30 days.

Re-invite User​

If a new user does not log in within 72 hours of receiving an invitation to join the platform, you must send a new invitation.

Reassign User to another Role​

Assign another role to a user when you want to delete the role that they are currently assigned or change the user role.

role Role​

Defines a user’s permissions within an organization. Roles can be predefined (Owner, Admin, Developer, Stakeholder) or custom.

Permission​

List of roles that grant access to a User to perform certain actions on the platform within an organization.

Permission includes: organization, projects, users, roles, API keys, domains, payment, integrations, templates, environments, variables and secrets, runtimes, metrics, logs.

domain Domain​

Domain configuration to subsequently deploy a runtime with the configured domain.

overview Overview​

A monthly report displaying an organization’s historical platform usage data.

payment-method Payment Method​

A method to pay for an organization’s platform usage. Users can add multiple payment methods. Currently, only credit cards are accepted.

integrations Integrations​

Establishes a connection between Cuemby Platform and a Git provider to automate application deployment processes.

Git Provider​

A Git provider that Cuemby Platform currently supports (GitHub, GitLab, Bitbucket).

Personal access token​

A credential that grants permissions to access a Git repository, enabling integration with Cuemby Platform.

Repository​

A Git repository where the application’s source code is stored, managed and versioned.

Workspace​

A space that can be associated with a personal or organization repository. If nothing is specified, Cuemby Platform creates a personal workspace by default.

Registry Provider​

A service that allows you to store, manage and distribute container images (e.g., Docker). It provides a centralized resource for discovering, distributing, and deploying application images, ensuring high availability.

Cloud Provider​

Provider that offers scalable computing resources that can be accessed on demand over a network.

Node​

A virtual or physical machine created in the selected cloud provider to run application workloads.

Kubernetes Connector​

An integration that uses configuration files to connect with the Kubernetes clusters, enabling application deployments on those architectures.

template Template​

A predefined configuration that allows you to select an integration and repository to create a runtime. The template also defines how the application should run, including environment variables, resource requirements, number of replicas, and other settings.

Containerization​

Cuemby Platform checks if an application is containerized (i.e., packaged with all its dependencies to run consistently across environments). If containerized, users can specify the Dockerfile path; otherwise, they can select the application's source code language.

Disabled integration​

When a user revokes integration access from a Git provider, the integration is disabled. To use it again, the user must reactivate it.

Dockerfile path​

A text document containing all the commands to build a Docker image.

Encrypt​

A property that indicates whether a variable contains sensitive data. In Cuemby Platform, users can choose to encrypt sensitive variables to enhance security.

Environment Variables​

Configuration variables that can be accessed by an application during runtime. They consist of a key-value pair. In Cuemby Platform, users can choose to encrypt sensitive environment variables for security.

Key​

The name of a variable.

Instance type​

The allocated computing resources for an application, including CPU and RAM.

PORT​

PORT through which the application is going to be exposed.

Value​

The value of a variable.

Registry​

A storage location for container images. Users can connect their own registry (e.g., Docker Hub, AWS ECR) or use Cuemby Platform's integrated registry.

Replica​

The number of instances of an application running when resource usage (CPU and memory) is below scaling thresholds.

Repository​

A Git repository where the application’s source code is stored, managed and versioned.

Source Code Language​

The programming language in which your application is built.

Traffic Type​

Type of network connection used by an application. Cuemby Platform allows users to define internal traffic (restricted to the namespace, blocking inbound and outbound external access) and external traffic (allows ingress and egress connections).

envs Environment​

A space to deploy applications and it is associated with a project.

vars-secrets Variables and Secrets​

Environment-specific configuration values that a runtime will use during execution. They consist of an environment, a key and a value and encryption for confidentiality.

runtime Runtime​

A runtime represents the execution environment for an application deployed in a specific environment and cloud provider, using allocated resources such as CPU and memory. It provides the necessary infrastructure to run the application based on predefined configurations.

Branch or Tags​

A repository branch or tag used to download the code to create a runtime.

Custom Domain​

Domain configuration used to deploy a runtime with a specified custom domain.

Custom Pipeline​

Additional tasks in the pipeline execution for runtime deployment.

  • Before task: Tasks to be executed prior to the default tasks for runtime deployment.
  • After task: Tasks to be executed after the default tasks for runtime deployment are finished.

Disable Integration​

When a user revokes the permissions in the Git provider, the main runtime screen displays the status, preventing the user from using that application until Git provider permissions are reactivated.

Health Check Protocol​

The status of the running service and how it is receiving requests. Users must select from HTTP, gRPC, TCP and Command as the health check type.

Pause/Restart​

Temporarily pauses or restarts a deployment for a specific duration.

Pipelines​

An automated sequence of actions and processes used to build, test and deploy an application. In Cuemby Platform, users are able to add custom tasks to pipelines while creating a runtime.

  • Task: A collection of steps designed to create the necessary resources for deploying applications.
  • Step: Individual actions that must be completed to execute a task (e.g., Docker runtime running a command).

URI or URL​

The link to access the application.

Rebuild​

Rebuild a runtime using the same configurations previously created by the user. This is used when changes were made to the Git repository and need to be incorporated into the runtime, or when modifications are made to an already running runtime.

Rollback​

Reverts to any of the last 10 previous builds.

Status​

The application status.

metrics Metrics​

Collection of data on the historical consumption of application resources of a runtime or environment over a specific period of time.

CPU​

Processing capacity, measured in milicores (mc).

Disk usage​

Persistent storage space allocated to an application.

Network​

Internal and external network traffic of a runtime, measured in Megabytes (MB) over specific time intervals.

Performance​

Identification of resource use of each environment.

RAM Memory​

Memory capacity, measured in Megabytes (MB).

Resource​

A combination of CPU and RAM allocated to a runtime.

logs Logs​

Logs are the console outputs generated by a runtime. They provide a chronological record of activities, including system actions and error messages from applications deployed within the runtime.