You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Feb 6, 2025. It is now read-only.
description: Learn about Amplication's Live Service Templates feature for creating and managing standardized service templates.
4
+
sidebar_label: Live Service Templates
5
+
slug: /live-service-templates
6
+
---
7
+
8
+
# Live Service Templates
9
+
10
+
Live Service Templates let your team define, manage, and maintain standardized templates for backend services. This feature enhances consistency across your projects and streamlines the process of creating new services.
11
+
12
+
:::note
13
+
The Live Service Templates feature is currently in beta.
14
+
:::
15
+
16
+
## Overview
17
+
18
+
Live Service Templates introduce several key components:
19
+
20
+
1.**Service Templates**: Pre-configured service blueprints that serve as a foundation for creating new services.
21
+
2.**Template-based Services**: New services created from existing templates, inheriting all settings and configurations.
22
+
3.**Template Management**: Tools for creating, editing, and maintaining service templates.
23
+
24
+
## Create a Service Template
25
+
26
+
Navigate to the [Platform Console](/platform-console) dashboard. Click on "Create Template".
27
+
28
+
The Service Template Creation Wizard will guide you through the process of setting up your template.
29
+
30
+
1.**Select Technologies**: Choose the name and back-end framework for your template.
31
+
32
+
33
+
34
+
2.**Choose APIs**: Select which APIs to include (REST API, GraphQL API, or both). Also, decide whether to generate an Admin UI for your templated service.
35
+
36
+
:::note
37
+
GraphQL API and Admin UI are currently not available with the .NET generator.
38
+
:::
39
+
40
+
41
+
42
+
3.**Database Selection**: Choose the database type for your template (e.g., PostgreSQL, MySQL, MongoDB, MS SQL Server).
43
+
44
+
45
+
46
+
After completing these steps, your new service template will be created and added to the Platform Console.
47
+
48
+
49
+
50
+
## Manage Service Templates
51
+
52
+
### Viewing Templates
53
+
54
+
To view and manage your templates:
55
+
56
+
1. Go to the Platform Console dashboard.
57
+
2. You'll see a list of all your service templates, each with its specific icon and type.
The Settings tab for service templates provides various configuration options:
80
+
81
+
1.**General**: Update the template name and description.
82
+
2.**APIs and Admin**: Toggle different API types (REST, GraphQL) and Admin UI.
83
+
3.**Base Directories**: Set the root directory for code placement when using the sync with Git feature. You can use `{{SERVICE_NAME}}` as a placeholder for the service name.
84
+
4.**Authentication Entity**: Choose the authentication entity for your template.
85
+
5.**Code Generator Version**: Select a specific version or use the latest.
86
+
87
+
:::note
88
+
You can of course update your **Base Directories**, but our recommendation is keeping the placholder.
After updating a template, you can apply these changes to existing services:
135
+
136
+
1. Go to the service created from the template.
137
+
2. You'll see the available updates in the Pending Changes sidebar.
138
+
3. Review the changes and click "Generate Code" to apply them.
139
+
140
+
This process will create a new commit with the updated configurations.
141
+
142
+
## Next Steps
143
+
144
+
Now that you have all the information you need to set up individiual template syou can start creating a collection of templates to standarize your organization's best practices.
145
+
146
+
:::tip
147
+
For any questions or issues related to Live Service Templates, please contact our support team or share your feedback in our [GitHub discussions](https://github.com/amplication/amplication/discussions).
description: Learn about Amplication's Platform Console, including templates and private plugins for standardizing service creation and management.
3
+
description: Learn about Amplication's Platform Console, a hub for managing platform-wide features and configurations.
4
4
sidebar_label: Platform Console
5
5
slug: /platform-console
6
6
---
7
7
8
-
The **Platform Console** is a powerful new feature in Amplication that allows your team to define, manage, and maintain standardized templates and private plugins for their backend services.
8
+
# Platform Console
9
+
10
+
The **Platform Console** is a powerful feature in Amplication that provides a centralized hub for managing platform-wide features and configurations. It allows your team to oversee and maintain standardized practices across your projects.
9
11
10
12
:::note
11
-
The Platform Console features, including the usage of templates and creation of services based on templates, are **currently in beta**.
13
+
Some Platform Console featuresare currently in beta.
12
14
:::
13
15
14
16
## Overview
15
17
16
-
The Platform Console introduces two main components:
18
+
The Platform Console introduces several key components:
17
19
18
-
1.**Platform Console Templates**: Pre-configured service templates that serve as a blueprint for creating new services.
20
+
1.[**Live Service Templates**](/live-service-templates): Pre-configured service templates that serve as a blueprint for creating new services.
19
21
2.**Private Plugins**: Custom plugins visible only to your organization that can be added to templates or services to extend functionality and/or keep your organization's best practices and standards.
20
22
21
-
These components are managed through a new dashboard interface, separate from the existing services view.
23
+
These components are managed through a dedicated Platform Console dashboard, separate from the existing services view.
-**Standardization**: Ensure all services follow organizational best practices and configurations.
28
-
-**Customization**: Create and use private plugins to tailor services to your organization's specific needs.
29
-
-**Efficiency**: Quickly create new services based on pre-defined templates.
29
+
-**Standardization**: Ensure all services follow organizational best practices and configurations with [Live Service Templates](/live-service-templates).
30
+
-**Efficiency**: Quickly create new services based on your templates.
31
+
-**Customization**: Create and use Private Plugins to tailor services to your organization's specific needs.
30
32
-**Smooth Maintenance**: Update multiple services from a single location. When you update a template, all services using that template can automatically get a PR with the required changes.
31
33
-**Technical Debt Prevention**: Implement organization-wide best practices across all services through templates and private plugins, creating a scalable architecture that resists the accumulation of technical debt as your project grows.
32
34
33
-
## Platform Console Templates
34
-
35
-
Platform Console Templates allow you to create a single source of truth for your services' architecture. These templates can include:
36
-
37
-
- Pre-configured settings
38
-
- Standard plugins
39
-
- Custom private plugins
40
-
41
-
### Creating a Template
42
-
43
-
To create a new template:
35
+
## Platform Console Features
44
36
45
-
1. Navigate to the Platform Console dashboard.
46
-
2. Click on "Create Template".
47
-
3. Provide a name for your template (e.g., "Node.js with PostgreSQL").
39
+
Live Service Templates is a powerful feature that allows you to create, manage, and use standardized templates for your backend services. Key aspects include:
53
40
54
-
### Managing Templates
41
+
-**Template Creation**: Define reusable service blueprints with pre-configured settings and plugins.
42
+
-**Service Generation**: Quickly create new services based on your defined templates.
43
+
-**Template Management**: Edit and update templates, with the ability to propagate changes to services.
55
44
56
-
Managing and updating templates is very similar to updating individual services. You have access to the same settings and most of the options available for services, including:
57
-
58
-
- Viewing all templates in the Platform Console dashboard.
59
-
- Adding or removing plugins, including custom plugins.
60
-
- Renaming templates and updating their descriptions.
61
-
62
-
To edit a template:
63
-
64
-
1. Navigate to the Settings tab to update the configuration or the Plugins tab to install and update plugins.
65
-
2. Make your desired changes.
66
-
3. All changes are saved automatically.
67
-
68
-
<!-- :::note
69
-
When you update a template, **all services using that template will be updated in your next build**, ensuring consistency across your infrastructure.
70
-
:::
71
-
-->
45
+
For detailed information on creating and using Live Service Templates, please refer to our [Live Service Templates](/live-service-templates) documentation.
72
46
73
-
### Using Templates
47
+
### Private Plugins
74
48
75
-
To create a new service based on a template:
76
-
77
-
1. Click on the "Add Resource" button.
78
-
2. Select "Service from Template" from the available options.
79
-
3. In the modal that appears, choose a specific service template.
80
-
4. Provide a name for your new service.
81
-
5. Click "Create" to generate the new service based on the selected template.
82
-
83
-
This process ensures that the new service inherits all the pre-configured settings and plugins defined in the template.
84
-
85
-
86
-
87
-
## Private Plugins
88
-
89
-
Private plugins allow you to create custom functionality specific to your organization's needs. These can be added to templates or directly to services.
49
+
Private plugins allow you to create custom functionality specific to your organization's needs. These can be added to services or used in templates.
90
50
91
51
:::note
92
52
Creating and managing private plugins requires an Enterprise plan.
93
53
:::
94
54
95
-
### Creating a Private Plugin
96
-
97
55
To create a private plugin:
98
56
99
57
1. In the Platform Console dashboard, navigate to the "Private Plugins" section.
@@ -102,21 +60,20 @@ To create a private plugin:
102
60
103
61
## Platform Changes Sidebar
104
62
105
-
The Platform Console introduces a new **_Platform_ Changes** sidebar that replaces the **_Pending_ Changes** sidebar. It's only visible when you're viewing the Platform Console.
63
+
The Platform Console introduces a new **Platform Changes** sidebar that shows changes made to platform-wide settings and configurations. This is separate from the **Pending Changes** sidebar, which shows service-level changes.
106
64
107
-
"Platform Changes" shows changes made to templates and private plugins, while "Pending Changes" still shows service-level changes.
Platform changes are separate from service-level changes. Make sure to review and commit platform changes separately from service changes.
68
+
Platform changes are _separate_ from service-level changes and are not commited to your git repo. Make sure to review and commit platform changes separately from service changes.
111
69
:::
112
70
113
-
114
-
115
71
## Conclusion
116
72
117
-
The Platform Console feature is designed to enhance the maintainability of your backend services, ensure organizational standardization, reduce technical debt, and streamline collaboration between platform and development teams.
73
+
The Platform Console is designed to enhance the maintainability of your backend services, ensure organizational standardization, reduce technical debt, and streamline collaboration between platform and development teams.
74
+
118
75
As this feature is currently in beta, we encourage you to explore its capabilities and share your feedback to help us further improve and refine it.
119
76
120
77
:::tip
121
78
For any questions or issues related to the Platform Console, please contact us or write your feedback on our [GitHub discussion](https://github.com/amplication/amplication/discussions/8979).
0 commit comments