Skip to content

Commit

Permalink
Merge branch 'main' into docs/git-sync-updates
Browse files Browse the repository at this point in the history
  • Loading branch information
dericksozo authored Sep 18, 2024
2 parents 331302d + 7eb8e88 commit a4dfac8
Show file tree
Hide file tree
Showing 4 changed files with 125 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/getting-started/generated-app.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Some of the key features of our generated backend services include:

- **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.
- **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.
- **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.
- **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.
- **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.

:::note
Expand Down
56 changes: 56 additions & 0 deletions docs/how-to/deploy.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
id: deploy
title: Amplication Deployment
sidebar_label: Overview
slug: /deploy
---

# Amplication Deployment

Amplication provides flexible and powerful deployment options for services generated using our platform.
This guide provides an overview of Amplication's deployment options and links to specific instructions for various deployment targets.

## Understanding Amplication's Deployment Architecture

Amplication services are composed of at least two main parts, all of which are automatically generated by our platform.

1. **API Server**
2. **Database**

Depending on your service requirements, Amplication can automatically generate the code for additional components such as:

- Message brokers like Kafka
- Caching solutions like Redis
- Other integrations specific to your service needs

These additional components are seamlessly integrated as containers in your `docker-compose` file.

All components, including optional ones, are auto-generated by Amplication.

## Deployment Options

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.

### Docker

Amplication generates all necessary configuration and scripts for Docker deployment, making it easy to containerize your application.

[Learn more about deploying with Docker](/deploy/docker-desktop)

### Kubernetes

For those looking to leverage the power of Kubernetes orchestration, Amplication provides the necessary plugins for a smooth deployment process.

[Learn more about deploying to Kubernetes](/deploy/kubernetes)

### Amazon Web Services (AWS) ECS

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.

[Learn more about deploying to AWS ECS](/deploy/aws/ecs)

## Request New Deployment Guides

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!

[Contact us with your deployment guide requests](https://meetings-eu1.hubspot.com/paz-yanover/product-overview-vp-product)
4 changes: 0 additions & 4 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -214,10 +214,6 @@ module.exports = {
to: "/user-entity",
from: ["/how-to/add-delete-user-entity"]
},
{
to: "/deploy/docker-desktop",
from: ["/deploy"]
},
{
to: "/getting-started/",
from: ["/guides/getting-started"],
Expand Down
71 changes: 68 additions & 3 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,74 @@ const sidebars = {
"how-to/how-to-set-access-permissions",
"getting-started/relations"
]
},
{
type: "category",
label: "Plugins",
link: {
type:"doc",
id: "getting-started/plugins"
},
items: [
"getting-started/plugins",
"getting-started/community-plugins",
"plugins/how-to-create-plugin",
"plugins/how-to-test-plugin",
"plugins/publish-plugin",
{
type: "category",
label: "Custom Plugin Architecture",
items: [
"plugins/plugin-architecture",
"plugins/plugin-events-before-after",
"plugins/context-skip-default",
"plugins/event-hierarchy",
],
},
{
type: "category",
label: "Custom Plugin Events - Reference",
items: [
"plugins/plugin-events/create-server",
"plugins/plugin-events/create-server-docker-compose",
"plugins/plugin-events/create-server-docker-compose-dev",
{
type: 'doc',
id: 'plugins/plugin-events/create-server-docker-compose-db',
className: 'plugin-event-not-recommended',
},
"plugins/plugin-events/create-server-dot-env",
"plugins/plugin-events/create-server-auth",
"plugins/plugin-events/create-package-json",
"plugins/plugin-events/create-entity-service",
"plugins/plugin-events/create-entity-service-base",
"plugins/plugin-events/create-entity-controller",
"plugins/plugin-events/create-entity-controller-base",
"plugins/plugin-events/create-entity-resolver",
"plugins/plugin-events/create-entity-resolver-base",
"plugins/plugin-events/create-message-broker-service",
"plugins/plugin-events/create-message-broker-service-base",
"plugins/plugin-events/create-message-broker-nestjs-module",
"plugins/plugin-events/create-message-broker-client-options-factory",
"plugins/plugin-events/create-message-broker-topics-enum",
"plugins/plugin-events/create-prisma-schema",
],
}
]
},
{
type: "category",
label: "Deployment",
link: {
type: "doc",
id: "how-to/deploy",
},
items: [
"how-to/deploy",
"getting-started/deploy-docker-desktop",
"how-to/deploy-kubernetes",
"how-to/deploy-to-aws-ecs",
]
},
{
type: "category",
Expand Down Expand Up @@ -143,9 +211,6 @@ const sidebars = {
},
"how-to/analytics-dashboard",
"how-to/understanding-break-the-monolith",
"getting-started/deploy-docker-desktop",
"how-to/deploy-kubernetes",
"how-to/deploy-to-aws-ecs",
"how-to/how-to-create-service",
"how-to/authentication-plugin-examples",
"how-to/create-message-broker",
Expand Down

0 comments on commit a4dfac8

Please sign in to comment.