- 15 Aug 2024
- Print
- DarkLight
- PDF
Services
- Updated On 15 Aug 2024
- Print
- DarkLight
- PDF
Overview
The services tab provides you the comprehensive list of all applications service installations created from the application package and DPK.
Service
A serverless computing Service allows users to run code without the need to manage servers or infrastructure. It can also be conceptualized as a deployed package that serves the code. When provided with the matching input for a function, it runs and returns the output.
Service Details
The list of services shows the following column details:
Fields | Description |
---|---|
Service Name | The name of the service and click on it to open the respective service page. Click on the Copy icon to copy the Service ID. |
Pending | The number of executions that are pending, for example, the status is Created. |
Scope | The project where the service is deployed. |
Status | The status of the services. To learn more, refer to the Service Status section. |
Instances | It displays the number of the instances. The execution last updated date. |
Version | The version number of the application (codebase) or package deployed by the service. To update it, click on the Update button when available. |
Created By | The avatar and email ID of the user who created the service. |
Created At | The timestamp of the service creation. |
Updated By | The avatar and email ID of the user who updated the service. |
Updated At | The timestamp of the service update. |
Functions | The number of functions available for the service, such as evaluate_model, predict_dataset, etc. |
- Play icon: Click on the Play icon to resume the services that are paused.
- Pause icon: Click on the Pause icon to pause the services that are active.
Schema Based Search and Filter
Schema Search is an integral component of the CloudOps, providing users with the capability to refine and narrow down the displayed services based on specific criteria. These filters offer a powerful tool for managing and exploring large information efficiently.
Click on the search field and specify the following criteria to perform a search. Press the Enter key to initiate the search:
Search Criteria | Description | Conditions | Data Types |
---|---|---|---|
app | Filter services based on application ID and name | = , != , IN , NOT-IN | String |
application | Filter services based on the application ID, name, and version. | = , != , IN , NOT-IN | String |
function | Filter services based on the service functions. | = , != , IN , NOT-IN | String |
model | Filter services based on the model ID and name. | = , != , IN , NOT-IN | String |
service | Filter services based on the service ID, name, and version. | = , != , IN , NOT-IN | String |
You can utilize the filter functionality by specifying the following criteria:
Filter Variable | Description |
---|---|
Channel - Model | It displays services such as predict, train, and evaluation services. |
Privacy - Active Project | By default, it displays all the services or apps in the current project. |
Privacy - All My Projects | It displays all the services or apps in the projects that the current user has access. |
Privacy - Public | It displays Dataloop global services and apps. |
Details Tab
Selecting a service displays more information of the service on the right-side panel. The Details tab includes the following sections:
- Service Actions: The service page allows you to perform various service related action.
- General Details:
- Service ID: Click on the copy icon to copy the Service ID.
- Application: It displays the application name.
- Click on the name to open the Manage Installations page of the Marketplace.
- Click on the copy icon to copy the application ID.
- Version: The application version (package/DPK) that is running on the service.
- Machine Type: The type of the machine used to for the service.
- Created By: Email ID and Avatar of the user who created the service.
- Service Created and Updated date
- Privacy: It displays as "project" since it is part of a project.
- Service Bot ID: It displays the Bot ID. Click on the copy icon to copy the Service Bot Username.
- Model type and name: It displays the model type and name. Click on the copy icon to copy the Model ID.
- Also, you can perform the following actions:
- Copy Service ID
- Copy Package ID
- Edit Service Configuration
- Copy email ID of the user who created and updated the service.
- Instances: The Instances section provides you the number of instances of the function.
- Executions: The Executions section provides you the number of executions available in the service. You can view details, such as execution ID, status, and creation date. Also, click on the execution ID to open the Executions tab of the service. To learn more, refer to the Execution article.
- Functions: The Functions section provides you the name of the functions available in the service.
- Triggers: The Triggers section provides you the number of triggers available in the service. Also, it provides trigger name, trigger type, and status. To learn more, refer to the Trigger article. Click on the Click here to add a new trigger.
Service Actions
The service page allows you to perform the following actions for your service:
How to Resume or Deactivate Services?
It allows you to deactivate or activate the service.
- Open CloudOps from the left-side menu.
- Select the service from the list. A right-side panel will be displayed.
- Click on the Service Actions, select:
- Deactivate Service: Click on it to deactivate the service that is in Active status.
- Resume Service: Click on it to resume the service that is in Inactive status.
How to Edit Service Settings?
It allows you to make changes on the Service Installation Configuration page, where you can add new triggers, edit service configuration.
- Open CloudOps from the left-side menu.
- Select the service from the list. A right-side panel will be displayed.
- Click on the Service Actions, select the Edit Service Settings option from the list. The Edit Service window is displayed.
- In the Settings section, review the following details and make changes, if needed:
init inputs value (1)
: The initial input or configuration values provided to a function when it is first invoked or initialized. The values are displayed, if theinit
inputs are defined in thedpk/dpkConfig
.- Hover over and click on the Edit Init Input to add a new value.
- Enter a value and click Save Changes.
- Secrets and Integrations: The secret values are displayed, if the
secret
is defined in thedpk/dpkConfig
.- Click on the Edit Secret to select secret(s) from the list. Also, you can search secrets by using the secret names and type.
- To create a new secret, click Edit Secret -> Create New -> Create Secret to create a new secret.
- To create a new Integration, click Edit Secret -> Create New -> Create Integration to create a new integration.
- Click Save Changes.
- Click on the Edit Secret to select secret(s) from the list. Also, you can search secrets by using the secret names and type.
- Service Configuration: Click on the Edit Configuration to make changes to the following fields, if needed:
- Machine Types: The machine type on which the service will run (refers to CPU, GPU, RAM).
- Change the machine type from the list.
- Click on the Machine Settings to enable Preemptible Machine, the reclaimable compute instances.
- Docker Image: A container image encapsulating essential dependencies and code for service execution. By default, the docker image based on the SDK version is displayed.
- Concurrency: Number of concurrent executions per instance. By default, the value 1 is displayed.
- Scaling Type: Choose the scaling type based on your workload.
- Autoscale: A component of the Dataloop FaaS system that automatically adjusts the number of serverless computing Resources allocated to the FaaS Service based on current demand. The purpose of the Autoscaler is to ensure that the system can handle peaks in demand without over provisioning Resources and incurring unnecessary costs.
- Min Instances: By default, 0. If you set the min instances to 0, the service will not run until it has something in the queue, it will be suspended.
- Max Instances: By Default, 10.
- Queue Size: By default, 10.
- Fixed size: By default, 1 instance is selected.
- Autoscale: A component of the Dataloop FaaS system that automatically adjusts the number of serverless computing Resources allocated to the FaaS Service based on current demand. The purpose of the Autoscaler is to ensure that the system can handle peaks in demand without over provisioning Resources and incurring unnecessary costs.
- Machine Types: The machine type on which the service will run (refers to CPU, GPU, RAM).
- Execution Configuration: Click on the Execution Configuration to make changes on the following fields:
- SDK Version: The SDK version is displayed.
- Execution Timeout: The maximum execution duration before service restarts (in seconds). By default, 3600 is displayed.
- Drain Time: Delays service restart to complete ongoing executions (in seconds). By default, 600 is displayed.
- On Reset Action: Action taken when a service is reset or restarted (e.g. timeout). Select one of the following when you reset the execution.
- Fail Execution
- Rerun Execution
- Max Attempts: Configures to automatically retry failed executions up to x attempts. Maximum number of execution attempts allowed. By default, 3 is displayed.
- Bot: A dummy user used for running the service ('developer' role). A default Bot is displayed. Select a new one from the list, if needed.
- Rerun executions as process: Defines if each execution will start a new thread or a process. Enable to make the execution as a process.
- In the Triggers (Optional), review and make changes, if needed:
- Click on the Pause/Play icon to deactivate/activate the trigger.
- Click Add Trigger to add a new trigger.
- Click on the Delete button to delete the trigger. A confirmation message is displayed.
- Click Save Changes to update the changes. A confirmation message is displayed.
How to Open Service Page?
You can either click on the service name from the CloudOps > Services tab or, follow the steps:
- Open CloudOps from the left-side menu.
- Select the service from the list. A right-side panel will be displayed.
- Click on the Service Actions.
- Select Open Service Page. It opens the Monitoring tab of the service page. To learn more, refer to the Service Page article.
How to Open VS Code?
It allows you to open the VS Code page and allows you to debug application services.
- Open CloudOps from the left-side menu.
- Select the service from the list. A right-side panel will be displayed.
- Click on the Service Actions.
- Select Open VS Code. To learn more, refer to the Open VS Code article.
How to Add a Trigger to the Service?
It allows you to add a new trigger for the service. To learn more, Trigger article.
- Open CloudOps from the left-side menu.
- Select the service from the list. A right-side panel will be displayed.
- Click on the Service Actions.
- Select Add Trigger from the list.
Trigger Name: Enter a trigger name. By default, a trigger name based on the service name is displayed.
Function: Select a function from the available list for the trigger to execute it. By default, a function is displayed. If the function has “item” input, then “item” will be the default value in the resource field.
Trigger Type: The Event based and Cron based triggers are available. If function inputs are not supported by event triggers, then cron trigger will be the default selection, and you cannot select “event” trigger.
- Event Type: It allows you to invoke a function in response to specific system events, using the triggering resource as the function's input.
- Resource: Select an entity type from the list. Event triggers support only the following types of function inputs: Item, Dataset, Model, Task, Assignment, and Annotation.
- Resource Filter: It allows you to filter any items or set a criteria (DQL filter) to target specific resources or events, ensuring the trigger responds only to these specified conditions.
- Events: Select the event (update, create, delete, etc.) that will trigger the function for the selected resource.
- Cron Type: It allows you to schedule the selected function to run at specific times by using a cron expression to define the execution intervals. Enter a specific schedule by using the cron expressions.
Cron expressions format
Value Schedule 0 * * * * Every hour */15 * * * * Every 15 mins 0 */2 * * * Every 2 hours 0 18 * * 1-6 Every week Mon-Sat at 6pm 10 2 * * 6,7 Every Sat and Sun on 2:10am 0 0 * * 0 Every Sunday midnight For example,
Minute Hour Day of Month Month Day of Week 0 */2 * C* * Result is Schedule: At 0 minutes past the hour, every 2 hours.
- Start At: The current date is displayed by default. Select a start date to set a time frame for the cron event.
- End At: This option is disabled by default, so there is no end date. To select an end date, uncheck the Never checkbox.
- Event Type: It allows you to invoke a function in response to specific system events, using the triggering resource as the function's input.
How to Activate UI Slots?
It allows you to activate the UI button to enable you to invoke and execute the functions from different places in the platform. You can activate UI slots only if the function has UI slots.
- Open CloudOps from the left-side menu.
- Select the service from the list. A right-side panel will be displayed.
- Click on the Service Actions.
- Select the Activate UI Slots from the list. To learn more, refer to the Activate UI Slots article.
How to Open GitHub Code?
It allows you to open the GitHub Code reference for the selected model. It will be unavailable if there is no fixed model selected.
- Open CloudOps from the left-side menu.
- Select the service from the list. A right-side panel will be displayed.
- Click on the Service Actions.
- Select the Open GitHub Code from the list. It opens the respective GitHub repository.
How to View Audit Logs?
It allows you to view the Audit Logs page related to your service.
- Open CloudOps from the left-side menu.
- Select the service from the list. A right-side panel will be displayed.
- Click on the Service Actions.
- Select the View Audit Logs from the list. The Audit Logs page is displayed.
How to Delete Services?
It allows you to uninstall the service. Deleting a service may have unintended implications for related objects including pipelines, UI slots, etc.
- Open CloudOps from the left-side menu.
- Select the service from the list. A right-side panel will be displayed.
- Click on the Service Actions.
- Select the Delete Service. A confirmation message is displayed.
- Click Yes to delete the service.