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

Commit 7eb8e88

Browse files
authored
Merge pull request #497 from amplication/docs/deploy-page
Docs: Deploy
2 parents 5583494 + 7d38ef1 commit 7eb8e88

File tree

4 files changed

+125
-8
lines changed

4 files changed

+125
-8
lines changed

docs/getting-started/generated-app.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Some of the key features of our generated backend services include:
1313

1414
- **Extensive Functionality**: The generated services provide a wide range of features, including authentication, authorization, data validation, logging, a database, and a REST API. For Node.js services, they also offer GraphQL APIs for efficient data communication and a React-based admin UI.
1515
- **Clean Architecture**: Both Node.js and .NET services are structured following the clean architecture principles, ensuring that the business logic is decoupled from the infrastructure and UI layers. This makes the code easier to maintain and test.
16-
- **Ready for Production**: The generated services include Docker configurations, CI/CD pipelines, and are optimized for cloud deployment, making it straightforward to move from development to production.
16+
- **Ready for Production**: The generated services are optimized for [deployment](/deploy/), include Docker configurations and CI/CD pipelines, making it straightforward to move from development to production.
1717
- **Customizable and Extendable**: While the service provides a solid foundation, it is fully customizable. Developers can extend the generated code with custom features and integrate additional services as needed.
1818

1919
:::note

docs/how-to/deploy.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
id: deploy
3+
title: Amplication Deployment
4+
sidebar_label: Overview
5+
slug: /deploy
6+
---
7+
8+
# Amplication Deployment
9+
10+
Amplication provides flexible and powerful deployment options for services generated using our platform.
11+
This guide provides an overview of Amplication's deployment options and links to specific instructions for various deployment targets.
12+
13+
## Understanding Amplication's Deployment Architecture
14+
15+
Amplication services are composed of at least two main parts, all of which are automatically generated by our platform.
16+
17+
1. **API Server**
18+
2. **Database**
19+
20+
Depending on your service requirements, Amplication can automatically generate the code for additional components such as:
21+
22+
- Message brokers like Kafka
23+
- Caching solutions like Redis
24+
- Other integrations specific to your service needs
25+
26+
These additional components are seamlessly integrated as containers in your `docker-compose` file.
27+
28+
All components, including optional ones, are auto-generated by Amplication.
29+
30+
## Deployment Options
31+
32+
When it comes to deployment, you have several options to choose from, allowing you to select the best approach for your development workflow and production needs.
33+
34+
### Docker
35+
36+
Amplication generates all necessary configuration and scripts for Docker deployment, making it easy to containerize your application.
37+
38+
[Learn more about deploying with Docker](/deploy/docker-desktop)
39+
40+
### Kubernetes
41+
42+
For those looking to leverage the power of Kubernetes orchestration, Amplication provides the necessary plugins for a smooth deployment process.
43+
44+
[Learn more about deploying to Kubernetes](/deploy/kubernetes)
45+
46+
### Amazon Web Services (AWS) ECS
47+
48+
Amplication has plugins that enable deployment to Amazon Web Services using Elastic Container Service (ECS). This option allows you to leverage AWS's managed container orchestration service for deploying, managing, and scaling your containerized applications.
49+
50+
[Learn more about deploying to AWS ECS](/deploy/aws/ecs)
51+
52+
## Request New Deployment Guides
53+
54+
We're always looking to expand our deployment options to meet the needs of our users. Is there a specific deployment target or cloud provider you'd like to see covered in our documentation? We'd love to hear from you!
55+
56+
[Contact us with your deployment guide requests](https://meetings-eu1.hubspot.com/paz-yanover/product-overview-vp-product)

docusaurus.config.js

-4
Original file line numberDiff line numberDiff line change
@@ -214,10 +214,6 @@ module.exports = {
214214
to: "/user-entity",
215215
from: ["/how-to/add-delete-user-entity"]
216216
},
217-
{
218-
to: "/deploy/docker-desktop",
219-
from: ["/deploy"]
220-
},
221217
{
222218
to: "/getting-started/",
223219
from: ["/guides/getting-started"],

sidebars.js

+68-3
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,74 @@ const sidebars = {
8383
"how-to/how-to-set-access-permissions",
8484
"getting-started/relations"
8585
]
86+
},
87+
{
88+
type: "category",
89+
label: "Plugins",
90+
link: {
91+
type:"doc",
92+
id: "getting-started/plugins"
93+
},
94+
items: [
95+
"getting-started/plugins",
96+
"getting-started/community-plugins",
97+
"plugins/how-to-create-plugin",
98+
"plugins/how-to-test-plugin",
99+
"plugins/publish-plugin",
100+
{
101+
type: "category",
102+
label: "Custom Plugin Architecture",
103+
items: [
104+
"plugins/plugin-architecture",
105+
"plugins/plugin-events-before-after",
106+
"plugins/context-skip-default",
107+
"plugins/event-hierarchy",
108+
],
109+
},
110+
{
111+
type: "category",
112+
label: "Custom Plugin Events - Reference",
113+
items: [
114+
"plugins/plugin-events/create-server",
115+
"plugins/plugin-events/create-server-docker-compose",
116+
"plugins/plugin-events/create-server-docker-compose-dev",
117+
{
118+
type: 'doc',
119+
id: 'plugins/plugin-events/create-server-docker-compose-db',
120+
className: 'plugin-event-not-recommended',
121+
},
122+
"plugins/plugin-events/create-server-dot-env",
123+
"plugins/plugin-events/create-server-auth",
124+
"plugins/plugin-events/create-package-json",
125+
"plugins/plugin-events/create-entity-service",
126+
"plugins/plugin-events/create-entity-service-base",
127+
"plugins/plugin-events/create-entity-controller",
128+
"plugins/plugin-events/create-entity-controller-base",
129+
"plugins/plugin-events/create-entity-resolver",
130+
"plugins/plugin-events/create-entity-resolver-base",
131+
"plugins/plugin-events/create-message-broker-service",
132+
"plugins/plugin-events/create-message-broker-service-base",
133+
"plugins/plugin-events/create-message-broker-nestjs-module",
134+
"plugins/plugin-events/create-message-broker-client-options-factory",
135+
"plugins/plugin-events/create-message-broker-topics-enum",
136+
"plugins/plugin-events/create-prisma-schema",
137+
],
138+
}
139+
]
140+
},
141+
{
142+
type: "category",
143+
label: "Deployment",
144+
link: {
145+
type: "doc",
146+
id: "how-to/deploy",
147+
},
148+
items: [
149+
"how-to/deploy",
150+
"getting-started/deploy-docker-desktop",
151+
"how-to/deploy-kubernetes",
152+
"how-to/deploy-to-aws-ecs",
153+
]
86154
},
87155
{
88156
type: "category",
@@ -141,9 +209,6 @@ const sidebars = {
141209
},
142210
"how-to/analytics-dashboard",
143211
"how-to/understanding-break-the-monolith",
144-
"getting-started/deploy-docker-desktop",
145-
"how-to/deploy-kubernetes",
146-
"how-to/deploy-to-aws-ecs",
147212
"how-to/how-to-create-service",
148213
"how-to/authentication-plugin-examples",
149214
"how-to/create-message-broker",

0 commit comments

Comments
 (0)