https://github.com/ever-co/ever-gauzy-pulumi
Deploy and Manage Ever® Gauzy™ Platform on Clouds with Pulumi
https://github.com/ever-co/ever-gauzy-pulumi
deployment gauzy pulumi
Last synced: 12 days ago
JSON representation
Deploy and Manage Ever® Gauzy™ Platform on Clouds with Pulumi
- Host: GitHub
- URL: https://github.com/ever-co/ever-gauzy-pulumi
- Owner: ever-co
- License: gpl-3.0
- Created: 2019-08-18T13:56:05.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-06-05T10:10:39.000Z (almost 2 years ago)
- Last Synced: 2025-04-21T18:00:29.108Z (14 days ago)
- Topics: deployment, gauzy, pulumi
- Language: TypeScript
- Homepage: https://gauzy.dev
- Size: 2.05 MB
- Stars: 26
- Watchers: 10
- Forks: 7
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Deploy and Manage Gauzy Platform on Clouds
## Introduction
- This projects uses [Pulumi](https://www.pulumi.com) to easy and quickly deploy [Gauzy Platform](https://github.com/ever-co/gauzy) into Clouds with single command (`pulumi up --yes`).
- It currently supports AWS Fargate Clusters (for web app and backend api), Application Load Balancers and Serverless PostgreSQL DB deployments.
- Read more [About Gauzy](https://github.com/ever-co/gauzy/wiki/About-Gauzy) and [How to use it](https://github.com/ever-co/gauzy/wiki/How-to-use-Gauzy) at your agency or studio.
## Quick start
- Setup [Docker](https://docs.docker.com/install)
- Setup [eksctl](https://docs.aws.amazon.com/en_pv/eks/latest/userguide/getting-started-eksctl.html) (if production k8s deployment required)
- Setup [Helm](https://helm.sh/docs/using_helm/#installing-helm) (if production k8s deployments required). Don't forget to run `helm init`!
- Setup [Pulumi](https://www.pulumi.com/docs/reference/install)
- Setup [AWS CLI](https://docs.aws.amazon.com/en_pv/cli/latest/userguide/cli-chap-install.html)
- Configure cloud credentials locally with `aws configure` and create AWS profile: `ever` (or replace AWS profile name in Pulumi.\*.yaml files)
- Change (optionally) Pulumi Stack with `pulumi stack select dev`, where `dev` is stack name.
- Deploy to Cloud: `pulumi up --yes`
- Enjoy
Note: different stacks may use different services, e.g. AWS EKS (k8s) for `prod` (production) stack, AWS ECS Fargate for `demo` stack or AWS ECS container instances (with EC2) for `dev` stack.
Links:
- Read more about Pulumi at
- For CircleCI configuration, see
## Implementation
Implementation currently based on Pulumi libraries specific to AWS Cloud.
That's why no other Clouds currently supported, but it should be possible at some point to rewrite code using Pulumi Cloud-Agnostic Packages,
see , , , etc.
(AWS and Azure clouds should be supported in such case)
Note: for some of AWS specific features (if Pulumi does not support them yet) we can use AWS CDK, see
### Branches, Pulumi Stacks and Environments
We have 3 branches for Gauzy Pulumi repo:
- `demo` branch for demo ( or , login with `[email protected]` and password: `admin`). Stack / Environment called `demo`.
- `master` branch for Production deployment (). Stack / Environment called `prod`.
- `develop` branch for Development deployment ("default" branch, ). Stack / Environment called `dev`.
Before Gauzy SaaS Platform will be ready, we just deploy current Gauzy Platform to all environments.
Note: sub-domains are subject to change.
Each Github branch correspond to separate Pulumi Stacks.
Mapping defined in the [./pulumi/ci.json](https://github.com/ever-co/gauzy-pulumi/blob/develop/.pulumi/ci.json) file.
In addition, Gauzy Platform build with different settings for each environment (e.g NODE_ENV set to `production` for production env)
## TODO
- [x] ~~Currently we need to manually manage DNS records in Cloudflare (for CNAMEs of api / app). We need to manage it all from this Pulumi project, there is Cloudflare Pulumi provider, already added~~
- [ ] Setup [Redash](https://github.com/getredash/redash) in the same cluster, see (optionally, but it's great to have that for Gauzy)
- [ ] Finish setup Github Actions, see
- [ ] Fix CircleCI build for this pulumi project: currently it does not have Docker in the build VM and so stage to build docker containers fails and also we should pull Gauzy repo into sub-folder for Docker builds or found another way. We also should fix PATH to docker files, which is hard-coded now like:
```typescript
const context = 'C:/Coding/Gauzy/gauzy';
const dockerfile = 'C:/Coding/Gauzy/gauzy/.deploy/webapp/Dockerfile';
```
See also and
- [ ] Security Group of Fargate Service should be added to RDS Cluster for full access to RDS DB. Note: it should be done this way: first we create such security group, next we use it when create RDS Cluster and next we use it when create Fargate Cluster
- Must READ: (how to setup k8s for production with Pulumi)
## Pulumi related FAQ
- Removed resource manually in the Cloud? Run `pulumi refresh`
## Pulumi related Open-Source projects and Examples
- Github Pulumi Actions: see and
-
-
-
-
-
- - this seems to be very good solution to run Jenkins in k8s with Pulumi
- - multi-cloud deployment for k8s
- - lots of micro-services and DBs (including Mongo / MySQL / RabbitMQ queue, etc)
## k8s
- Run proxy: `kubectl proxy`
- Get all running pods: `kubectl get pods -A`
## Contribute
- Please give us :star: on Github, it **helps**!
- You are more than welcome to submit feature requests
- Pull requests are always welcome! Please base pull requests against the _develop_ branch and follow the [contributing guide](.github/CONTRIBUTING.md).
## Collaborators and Contributors
### Development Team
#### Core
- Ruslan Konviser ([Evereq](https://github.com/evereq))
### Contributors
- View all of our [contributors](https://github.com/ever-co/gauzy/graphs/contributors)
## Contact Us
- [Slack Community](https://join.slack.com/t/gauzy/shared_invite/enQtNzc5MTA5MDUwODg2LTI0MGEwYTlmNWFlNzQzMzBlOWExNTk0NzAyY2IwYWYwMzZjMTliYjMwNDI3NTJmYmM4MDQ4NDliMDNiNDY1NWU)
- [Spectrum Community](https://spectrum.chat/gauzy)
- [Gitter Chat](https://gitter.im/ever-co/gauzy)
- [CodeMentor](https://www.codementor.io/evereq)
- For business inquiries:
- Please report security vulnerabilities to
- [Gauzy Platform @ Twitter](https://twitter.com/gauzyplatform)
- [Gauzy Platform @ Facebook](https://www.facebook.com/gauzyplatform)
## Security
Gauzy™ follows good security practices, but 100% security cannot be guaranteed in any software!
Gauzy™ is provided AS IS without any warranty. Use at your own risk!
See more details in the [LICENSE](LICENSE).
In a production setup, all client-side to server-side (backend, APIs) communications should be encrypted using HTTPS/WSS/SSL (REST APIs, GraphQL endpoint, Socket.io WebSockets, etc.).
## License
This software is available under [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.txt)
This program is free software: you can redistribute it and/or modify it under the terms of the corresponding licenses described in the LICENSE files located in software sub-folders and under the terms of licenses described in individual files.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
You should have received a copy of the relevant GNU Licenses along with this program. If not, see http://www.gnu.org/licenses/.
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fever-co%2Fgauzy-pulumi?ref=badge_large)
## Trademarks
Gauzy™ is a trademark of Ever Co. LTD.
All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.
_Copyright © 2019, Ever Co. LTD. All rights reserved._