Create a private service

更新时间:
复制 MD 格式

A private service is one that deploys all its resources and software to the customer's Alibaba Cloud account. This topic describes how a service provider can create a private service in the Compute Nest console.

Procedure

  1. Log on to the Compute Nest console.

  2. In the left-side navigation pane, choose My Services. On the My Services page, click the Created Services tab, and then click Create Service.

  3. On the Create Service page, configure the service information.

    1. Select a method to create the service.

      You can choose to Create Service from Featured Templates or Build Custom Service.

      • Create from Featured Template: Compute Nest provides service templates for various architectures and applications to help you quickly create services.

      • Build Custom Service: Compute Nest provides a complete service creation workflow. You must configure the service information, service deployment, service O&M, and advanced settings.

    2. Under Select a service type, select Private Service.

      If you chose Create Service from Featured Templates, you must first select Private Service and then select a service template.

      Note

      After you select a service template, you can click View Details to view the deployment description and configuration files for the template.

    3. Click Next: Configure Settings.

    4. On the service configuration page, configure the service details.

      • If you chose to Create Service from Featured Templates, you only need to configure the basic information for the service.

        Note

        The service icon and service name are pre-filled with the values from the service template. You can modify the service icon and name as needed.

      • If you chose to Build Custom Service, you must configure all the service information.

        1. In the Basic Information section, configure the basic service details.

          Parameter

          Description

          Service Icon

          The icon of the service. The JPG and PNG formats are supported. We recommend that you upload an image whose resolution is 192 × 192 pixels for optimal clarity.

          Service Name

          The name of the service. The name must be 3 to 200 characters in length, and can contain digits, letters, and underscores (_).

          Service Description

          The description of the service. The description must be 10 to 500 characters in length.

          Service Agreement Document

          Enter the name and URL for your custom service agreement document.

          Version Description

          The description of the service version. The version description must be 1 to 200 characters in length. We recommend that you include a version number in the description. The description of each version of a service must be unique.

          Default Prefix for Service Instance Name

          The default prefix of service instance names. The prefix can be up to 40 characters in length, and can contain digits, letters, hyphens (-), and underscores (_). The prefix must start with a letter.

          After you specify the default prefix, the prefix is automatically entered in the Service Instance Name field when customers create a service instance. Customers can modify the prefix.

          Tag Settings

          The tag key and value. Select or enter a tag key and a tag value to add a tag to the service resources. You can add up to 20 tags to each resource. If no tag key or tag value is available, you can create a custom tag. For more information, see Add a custom tag.

          Resource Group

          Select the resource group to which you want to add your resources.

          Resource groups allow you to group your cloud resources based on purpose, permission, or ownership. This simplifies resource management for multiple users and projects within an enterprise. For more information, see Resource Group.

        2. In the Service Deployment section, configure the resources required for the service.

          Parameter

          Description

          Deployment Settings

          Regions

          The regions in which service instances can be deployed. By default, All Regions is selected.

          nst.vendor.create.tplInputType.label

          Enter the Template Name and Template Content. You can upload a prepared template file. ROS JSON, ROS YAML, and Terraform formats are supported. For more information, see Resource Orchestration Service (ROS).

          • If your business scenario requires different types of templates within the same service, you can add multiple templates. Click the 添加 icon next to Template 1 to add another template. For example, to support both single-availability-zone and multi-availability-zone deployments, you can add a separate template for each scenario.

            Important

            In templates that support trials, you cannot create a new Virtual Private Cloud (VPC) or vSwitch. Instead, set the VPC and vSwitch as template parameters.

            The security group used in a trial template must be newly created. You cannot select an existing security group.

          Add Package

          Based on the template content, select the package parameters to configure and set their values. If you want customers to be able to customize all parameters within a package when creating a service instance, select Support Custom Parameter Set. Otherwise, do not select it. For details about package settings, see Package settings.

          Deployed At

          Estimated Time

          The estimated time for deploying a service instance. If you configure this parameter, the specified value is displayed on the service instance deployment page to inform customers of the average time required to deploy a service instance.

          Timeout Period

          The timeout period for deploying a service instance. When customers deploy a service instance, if the time consumed exceeds the specified timeout period, the deployment fails. This parameter is required only for private services.

          Deployment Package Association

          Set ECS Image Association

          You can set this parameter to replace the Elastic Compute Service (ECS) image specified in the template with the ECS image in the deployment package that has been distributed. For more information, see ECS image deployment package.

          Set Container Image Association

          We recommend that you use Container image deployment packages if Docker container images are used for service deployment. For more information, see Container image deployment package.

          Set File Association

          Compute Nest provides file deployment packages to resolve the issues that you may encounter when you download software resources for script-based deployment. For example, the cloud resources are inaccessible over the Internet, or the download source of the resources is not stable. For more information, see File deployment packages.

          Set Helm Association

          If your chart package must be kept private, we recommend using Helm chart artifacts from Compute Nest. For more information, see Helm chart artifacts.

          Application Group

          Create Application Group

          The application groups of resources in the template. You can add resources in the template to application groups. This facilitates resource check and management for customers. On the details page of service instances, customers can view resources, view monitoring data, perform O&M operations, and view logs by group. For more information, see Configure application groups.

          Note

          Each resource can be added to only one group.

        3. In the Service O&M (Optional) section, configure the O&M features for the service.

          Parameter

          Description

          O&M

          Obtain Permissions

          Specifies whether to enable the hosted O&M feature.

          • To enable the hosted O&M feature, select Obtain Permissions and select the permissions that customers need to grant to service providers.

          • To disable the hosted O&M feature, clear Obtain Permissions.

          For more information, see Hosted O&M for private services.

          Add O&M Operation

          Configure the O&M operations that appear on the customer's O&M management page. For more information, see Custom O&M operations.

          Monitoring

          Resource Monitoring

          The monitoring configurations. If you want to receive alert notifications, you must select Obtain Permissions and then select Monitoring Permissions.

          • Configure CloudMonitor Alert Template for All Resources: Select a CloudMonitor alert template.

          • Configure CloudMonitor Alert Template for All Resources: Select a CloudMonitor alert template for each application group.

            Note

            This option is available only if application groups are configured.

          If no alert template is available, create one first. For more information, see Monitoring and alerting overview.

          Log

          Application Log

          Configure the Logstore information for the service's application logs.

          Click Add Logstore. In the dialog box that appears, set the Logstore name, log path, and log file name.

          Note
          • For services deployed on ECS, you must set the log path and file name.

          • For services deployed in containers, you must configure Logstore information in the container's environment variables.

          Upgrade

          nst.vendor.create.upgrade.type.desc

          Specifies whether to enable the upgrade feature. If you disable this feature, you do not need to configure the following parameters.

          • Rolled Back by Customers: specifies whether to allow customers to roll back their service instances to the original version from a later version. By default, this rollback is supported.

          • nst.vendor.create.upgrade.description.label: the upgrade content or the description of new features.

          • nst.vendor.create.upgrade.version.label: the service versions that have been published. You can select one or more versions. By default, All Versions is selected.

          • nst.vendor.create.upgrade.components.label: the upgrade scope.

            • Service Configurations: updates only the configurations of service instances, such as hosted O&M settings and O&M notification settings. No software applications are upgraded. This option is selected by default.

            • Resource Configurations: updates the resources in ROS or Terraform templates. No additional configurations are required if you select this option.

            • Application Configurations: upgrades software applications by replacing image or file deployment packages. Additional configurations are required if you select this option.

          • Configure Upgrade Parameters: This parameter is required if you select Application Configurations for nst.vendor.create.upgrade.components.label.

            For more information about how to configure this parameter, see Configure service upgrades. If you have configured multiple application groups, you can separately configure upgrade settings for each application group. For more information about application groups, see Configure application groups.

          Modify Configurations

          Service Instance Configuration Change

          Specifies whether to enable the configuration change feature. If you disable this feature, you do not need to configure the following parameters.

          Click Add Operation. In the dialog box that appears, configure the configuration change operation.

          • Select Template: the template that is used to implement the configuration change.

            Note
            • To enable instance type change, you must set the UpdatePolicy property of the ALIYUN::ECS::InstanceGroup resource to ForAllInstances in the template.

            • To enable the update of the ALIYUN::ECS::RunCommand resource, you must set the Syns property to true in the template. The updated ALIYUN::ECS::RunCommand resource is re-executed during the configuration change.

          • Operation Name: the name of the configuration change operation.

          • Operation Description: the description of the configuration change operation.

          • Operation Type: the type of the configuration change operation. Valid values: Upgrade, Downgrade, and Custom. You can select only one operation type.

            • Upgrade: If you select Change Plan as Method, customers can upgrade service instances by changing the current parameter set to a parameter set with a larger serial number. If you select Change Parameter as Method, customers must set parameters of a numeric type to larger values when they upgrade service instances. Custom parameter sets do not support upgrade operations.

            • Downgrade: If you select Change Plan as Method, customers can downgrade service instances by changing the current parameter set to a parameter set with a smaller serial number. If you select Change Parameter as Method, customers must set parameters of a numeric type to smaller values when they downgrade service instances. Custom parameter sets do not support downgrade operations.

            • Custom: No limits are set on the configurations of parameter sets and parameters, and custom parameter sets are supported.

          • Method: the configuration change method.

          • Select Parameters: the parameters that can be modified by customers. This parameter is available only if you select Change Parameter as Method. Parameters that cannot be changed are filtered out.

        4. In the Advanced Configuration (Optional) section, configure advanced features for the service.

          Note

          Sales-related settings, such as licenses and Alibaba Cloud Marketplace listings, are configured after the service is created. For more information, see Sales Management.

          Parameter

          Description

          Permission Settings

          Permission Type

          Set the access permissions for the service deployment URL.

          • Public: Any customer with the deployment URL can create service instances.

          • Restricted: Only customers added to the deployment URL's permission whitelist can access or create service instances. For more information, see Modify service deployment permissions.

          • Hidden: The service details page is hidden from customers who are not on the permission whitelist. When an unauthorized customer opens the deployment URL, the console shows a message that the service does not exist.

          Trial Settings

          Support Trial

          Select whether to support free trials for the service.

          If you have configured packages, you can select one or more of them as trial packages. If no packages are configured, you can specify one or more templates as trial templates. For more information, see Configure free trials.

          Maximum Trial Period

          The maximum trial duration of a service instance. This parameter takes effect only for trial service instances. It is invalid for formal service instances. The trial duration can be up to 30 days.

          Important

          The resource fees generated by trial service instances are paid by Alibaba Cloud. However, these resources consume your free trial quota. To achieve a balance between a good trial experience and an ideal number of trial customers, we recommend that you configure appropriate parameter sets and templates for trial service instances and specify an appropriate trial duration.

          Network Settings

          VPC Private Access

          Select whether to enable a private link from the service instance to a central service. This parameter can be set only when the trial feature is disabled. If this is not enabled, the subsequent parameters do not need to be configured.

          Note

          This configuration currently supports only establishing a private connection from a customer's private service VPC to a service provider's custom endpoint service.

          • Endpoint Service Configuration: Select the region and details for the endpoint service. Only one endpoint service can be set per region. If you need to provide Compute Nest services in multiple regions, you must set an endpoint service for each region.

            If you cannot find the desired endpoint service, you can create one. For details about how to create an endpoint service, see Create and manage endpoint services.

          • Custom Domain Name: When creating a service instance, customers can choose to use this domain name to access your service over the private network. We recommend that the custom domain name be consistent with your service's public domain name.

          Distribution Settings

          Allow distributors to request distribution authorization

          If you enable this option, Compute Nest distributors can apply for distribution authorization for this service, and you will receive a review notification. If you approve the authorization, the distributor can re-create and distribute the service. You must arrange a separate settlement process with the distributor.

  4. Click Create Service, and then click OK in the confirmation dialog box.

    In the prompt that appears, you can click View Service or Test Service Now.

Results

After the service is created, you can view it on the My Services page.

The service is displayed as a card on the Created Services tab. Each card shows the service version, update time, and actions such as Unpublish Service and Pre-publish.

Next steps

  1. Test the service.

    After you save the service, you can test it. You can also pre-publish the service and share it with specific customers for testing. For more information, see Test a service.

  2. Publish the service.

    After the service passes testing, submit it for review. Once approved, you can publish the service. For more information, see Publish a service.