Skip to content
This repository was archived by the owner on Feb 6, 2025. It is now read-only.

Commit 2cbeaf2

Browse files
dericksozodericksozo
authored
Merge branch 'main' into docs/git-sync-updates
2 parents 25516bd + 6ad6f99 commit 2cbeaf2

7 files changed

+127
-4
lines changed

‎docs/how-to/assets/amplication-platform-console.png

46.6 KB
Loading

‎docs/how-to/assets/create-service-from-template.png

233 KB
Loading

‎docs/how-to/assets/platform-changes.png

41.8 KB
Loading

‎docs/how-to/assets/template-name-and-stack.png

24.4 KB
Loading

‎docs/how-to/platform-console.md

+122
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
---
2+
title: Platform Console
3+
description: Learn about Amplication's Platform Console, including templates and private plugins for standardizing service creation and management.
4+
sidebar_label: Platform Console
5+
slug: /platform-console
6+
---
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.
9+
10+
:::note
11+
The Platform Console features, including the usage of templates and creation of services based on templates, are **currently in beta**.
12+
:::
13+
14+
## Overview
15+
16+
The Platform Console introduces two main components:
17+
18+
1. **Platform Console Templates**: Pre-configured service templates that serve as a blueprint for creating new services.
19+
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+
21+
These components are managed through a new dashboard interface, separate from the existing services view.
22+
23+
![Amplication Platform Console](./assets/amplication-platform-console.png)
24+
25+
## Benefits
26+
27+
- **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.
30+
- **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+
- **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+
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:
44+
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").
48+
4. Select the desired components (e.g., Admin UI, GraphQL API, REST API).
49+
5. Choose a database (e.g., PostgreSQL).
50+
6. Click "Create" to finalize the template.
51+
52+
![Amplication Create New Template](./assets/template-name-and-stack.png)
53+
54+
### Managing Templates
55+
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+
-->
72+
73+
### Using Templates
74+
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+
![Amplication Create Services From Template](./assets/create-service-from-template.png)
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.
90+
91+
:::note
92+
Creating and managing private plugins requires an Enterprise plan.
93+
:::
94+
95+
### Creating a Private Plugin
96+
97+
To create a private plugin:
98+
99+
1. In the Platform Console dashboard, navigate to the "Private Plugins" section.
100+
2. Click on "Create Private Repository".
101+
3. Connect to your plugin repository and add your existing private plugins to the project.
102+
103+
## Platform Changes Sidebar
104+
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.
106+
107+
"Platform Changes" shows changes made to templates and private plugins, while "Pending Changes" still shows service-level changes.
108+
109+
:::note
110+
Platform changes are separate from service-level changes. Make sure to review and commit platform changes separately from service changes.
111+
:::
112+
113+
![Amplication Create Services From Template](./assets/platform-changes.png)
114+
115+
## Conclusion
116+
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.
118+
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+
120+
:::tip
121+
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).
122+
:::

‎docusaurus.config.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,9 @@ module.exports = {
7777
label: "Plugins",
7878
},
7979
{
80-
to: "/how-to/import-prisma-schema/",
80+
to: "/platform-console/",
8181
position: "left",
82-
label: "Import DB",
82+
label: "Platform Console",
8383
},
8484
/* {
8585
to: "/deploy",

‎sidebars.js

+3-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ const sidebars = {
1313
"getting-started/set-up-entities",
1414
"getting-started/configure-roles-and-permissions",
1515
"getting-started/add-plugins-for-service",
16-
"getting-started/commit-changes-and-build-new-versions",
17-
"getting-started/add-custom-code"
16+
"how-to/platform-console",
17+
"getting-started/add-custom-code",
18+
"getting-started/commit-changes-and-build-new-versions"
1819
],
1920
},
2021
{

0 commit comments

Comments
 (0)