Skip to content

Commit

Permalink
Harmonix rebrand (#101)
Browse files Browse the repository at this point in the history
* Harmonix changes

* readme updates

* updates for website

---------

Co-authored-by: Zahi Ben Shabat <zshabat@amazon.com>
  • Loading branch information
z-sourcecode and Zahi Ben Shabat authored Aug 27, 2024
1 parent e2f661e commit f75616b
Show file tree
Hide file tree
Showing 57 changed files with 452 additions and 320 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
# Crash log files
crash.log

.docusaurus
# *.zip
*.pem
backstage-old
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Changelog

## 0.3.4 - 2024-08-23
* Upgraded OPA on AWS to the latest Backstage version and new backend system. 1.29.0
* Upgraded Harmonix on AWS to the latest Backstage version and new backend system. 1.29.0
* New custom entity processor plugin - compatible with the new backend backstage system. <a href="docs/techdocs/plugins"> details here </a>
* Updated Gitlab version 17.2.2
* Support for Github and Multi-Git provider
Expand Down
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<img src="./docs/images/opa-logo.png"
alt="OPA on AWS"
<img src="./docs/images/harmonix-blue.png"
alt="Harmonix on AWS"
style="margin-right: 10px;max-height: 400px; " />

:star: **OPA on AWS v0.3.4 now available!** :star:
* Upgraded OPA on AWS to the latest Backstage version and new backend system. 1.29.0
:star: **Harmonix on AWS v0.3.4 now available!** :star:
* Upgraded Harmonix on AWS to the latest Backstage version and new backend system. 1.29.0
* New custom entity processor plugin - compatible with the new backend backstage system. details here
* Updated Gitlab version 17.2.2
* Support for Github and Multi-Git provider
Expand All @@ -14,7 +14,7 @@
* Bug fixes


:star: **OPA on AWS v0.3.3** :star:
:star: **Harmonix on AWS v0.3.3** :star:
* S3 Bucket as a shared resource
* Reuse existing VPC when creating providers
* Amazon ECS provider with EC2 clusters for tailored workloads
Expand All @@ -26,32 +26,32 @@
* Updated Backstage platform to v1.21
* Filter relevant environments for new apps

Refer to the [CHANGELOG](https://opaonaws.io/docs/CHANGELOG) for a complete list of new features and capabilities.
# OPA (Orchestrate Platform and Applications) on AWS
Refer to the [CHANGELOG](https://harmonixonaws.io/docs/CHANGELOG) for a complete list of new features and capabilities.
# Harmonix on AWS (Previously known as OPA on AWS)

OPA Provides a new developer experience to simplify the use and consumption of AWS services while minimizing required expertise in cloud infrastructure technologies.
Harmonix Provides a new developer experience to simplify the use and consumption of AWS services while minimizing required expertise in cloud infrastructure technologies.
Built on the [Backstage open platform](https://backstage.io), this solution makes the AWS cloud more accessible to application developers allowing them to focus on building application logic and delivering business value.

This solution leverages the flexibility and extensibility of the Backstage platform to provide customizable software templates, scaffolder actions, and deployment patterns. While this provides a lot of freedom in implementation, it can be overwhelming to get started. To help users get started, a reference repository is also provided with samples to show how to use the solution.

:clapper: **Demonstrations and Tutorials**

[OPA on AWS Website](https://opaonaws.io) <br/>
[OPA on AWS Documentation](https://opaonaws.io/docs/intro) <br/>
[Tutorial YouTube videos](https://www.youtube.com/playlist?list=PLhr1KZpdzukcf5e7vYOVkpw4h-rzy7Pn3)
[Harmonix on AWS Website](https://harmonixonaws.io) <br/>
[Harmonix on AWS Documentation](https://harmonixonaws.io/docs/intro) <br/>
[Tutorial YouTube videos](https://harmonixonaws.io/docs/getting-started/videos)

## Getting Started
Please see our [Getting started documentation](https://opaonaws.io/docs/getting-started/deploy-the-platform)
Please see our [Getting started documentation](https://harmonixonaws.io/docs/getting-started/deploy-the-platform)

## 1. Architecture Overview
See our [high level architecture](https://opaonaws.io/docs/techdocs/architecture)
See our [high level architecture](https://harmonixonaws.io/docs/techdocs/architecture)
For details on the solution architecture lower level design. -> [ARCHITECTURE.md](./docs/ARCHITECTURE.md)

## 2. Installation
Please see our [Installation instructions](https://opaonaws.io/docs/getting-started/deploy-the-platform)
Please see our [Installation instructions](https://harmonixonaws.io/docs/getting-started/deploy-the-platform)

## 3. FAQs
Please see our [FAQs page](https://opaonaws.io/docs/faq)
Please see our [FAQs page](https://harmonixonaws.io/docs/faq)

## Security

Expand Down
Binary file added docs/images/harmonix-blue.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/harmonix-white.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 17 additions & 17 deletions website/docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,37 +63,37 @@ If you discover a potential security issue in this project we ask that you notif
See the [LICENSE](https://github.com/awslabs/app-development-for-backstage-io-on-aws/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.


## Contributing Assets to OPA on AWS
## Contributing Assets to Harmonix on AWS

Thank you for considering a contribution to OPA on AWS project!
Thank you for considering a contribution to Harmonix on AWS project!
The above described guidelines are to set the standard of submitting Pull Request, That is in conjunction to the below description

### Contribution Type

1. Contributing OPA on AWS Templates
1. Contributing Harmonix on AWS Templates
1. Provider Template
2. App Template
3. Resource Template
4. Other Template
2. Contributing OPA on AWS Pipelines
2. Contributing Harmonix on AWS Pipelines
1. New pipeline pattern
2. Update existing pipeline pattern
3. Contributing OPA on AWS Core modifications
1. Change in UI / Frontend of OPA on AWS plugins
2. Change in SDK API / Backend of OPA on AWS Plugins
3. Contributing Harmonix on AWS Core modifications
1. Change in UI / Frontend of Harmonix on AWS plugins
2. Change in SDK API / Backend of Harmonix on AWS Plugins
3. Change in sacffolder actions
4. Change in architecture or platform design
5. Change in common interfaces
4. Contributing OPA on AWS extensions
4. Contributing Harmonix on AWS extensions
1. Integration with new tools and plugins
2. Integration with additional Backstage.io APIs / entities
3. Extending OPA on AWS model
3. Extending Harmonix on AWS model

### Submitting Contribution

Before submitting any contribution type please make sure it adheres to the OPA on AWS [architecture](https://opaonaws.io/docs/techdocs/architecture)
Before submitting any contribution type please make sure it adheres to the Harmonix on AWS [architecture](https://harmonixonaws.io/docs/techdocs/architecture)

### Contributing an OPA on AWS provider
### Contributing an Harmonix on AWS provider

Questions to consider when designing new provider:
1. Why do i need a new provider? does the existing providers support the type of application I'm trying to build?
Expand Down Expand Up @@ -127,25 +127,25 @@ Don't forget to update all-templates.yaml with your new template path
#### Test your provider
**Step 1**<br/>
Make sure you are able to provision your new provider template.
We highly recommend to test different context for this step as described in the [test-cases](https://opaonaws.io/docs/tests)
We highly recommend to test different context for this step as described in the [test-cases](https://harmonixonaws.io/docs/tests)

**Step 2**<br/>
Make sure you can update the provider configurations or IAC and the pipeline will apply the changes succufully

**Step 3**<br/>
Add entries in [test-cases](https://opaonaws.io/docs/tests) document for the new provider implemented.
Add entries in [test-cases](https://harmonixonaws.io/docs/tests) document for the new provider implemented.

#### Submit your PR
Submit a pull request for the new provider following the instructions in this page.


### Contributing an OPA on AWS application
### Contributing an Harmonix on AWS application

Questions to consider when designing a new application pattern:

1. Who is the team that going to be using this application template? does it address their requirements?
2. What pattern this new application introduce? is there already an existing pattern that can be used?
3. Does this application can use an existing environment or it requires a new environment type / provider? if so, see the above *Contributing an OPA on AWS provider*
3. Does this application can use an existing environment or it requires a new environment type / provider? if so, see the above *Contributing an Harmonix on AWS provider*
4. What kind of permissions and resources this application needs?
5. What kind of operational actions this application need? which of them can be supported through a pipeline and which one needs a UI of platform changes?
6. Will this application support upgrades? what will be the effect of the deployed applications if we were to be update it?
Expand Down Expand Up @@ -177,15 +177,15 @@ Don't forget to update all-templates.yaml with your new template path
#### Test your application
**Step 1**<br/>
Make sure you are able to provision your new application template.
We highly recommend to test different context for this step as described in the [test-cases](https://opaonaws.io/docs/tests).
We highly recommend to test different context for this step as described in the [test-cases](https://harmonixonaws.io/docs/tests).
You should also test provisioning another application on the same environment to make sure there's not conflict of configurations and/or resources.

**Step 2**<br/>
1. Make sure you can update the application configurations or IAC and the pipeline will apply the changes successfully
2. Make sure you can update the application code /src and CD pipeline will build and deploy the new application

**Step 3**<br/>
Add entries in [test-cases](https://opaonaws.io/docs/tests) document for the new application implemented.
Add entries in [test-cases](https://harmonixonaws.io/docs/tests) document for the new application implemented.

#### Submit your PR
Submit a pull request for the new provider following the instructions in this page.
54 changes: 27 additions & 27 deletions website/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,55 +6,55 @@ toc_max_heading_level: 4

# FAQ

#### What is OPA on AWS?
#### What is Harmonix on AWS?
>
> Orchestrate Platforms and Applications (OPA) on AWS is an open source reference implementation that ties together AWS services into an enterprise ready solution. By abstracting AWS services, OPA on AWS allows application developers to focus on what they do best – writing application logic code, all while allowing platform engineering teams to enforce internal guardrails and best practices at scale. OPA on AWS provides a productive and efficient experience for non-cloud developers and allows for integrations with your current tooling. It is fast, safe, fun, and at-scale.
> Harmonix on AWS is an open source reference implementation that ties together AWS services into an enterprise ready solution. By abstracting AWS services, Harmonix on AWS allows application developers to focus on what they do best – writing application logic code, all while allowing platform engineering teams to enforce internal guardrails and best practices at scale. Harmonix on AWS provides a productive and efficient experience for non-cloud developers and allows for integrations with your current tooling. It is fast, safe, fun, and at-scale.
<br/>
#### What does OPA on AWS do?
#### What does Harmonix on AWS do?
>
> OPA on AWS provides a comprehensive Internal Developer Platform solution. It allows developers to write application logic, on AWS, without having to know how to provision and manage AWS services. OPA on AWS also allows platform engineering teams to easily manage all the resources and applications that run on AWS.
> Harmonix on AWS provides a comprehensive Internal Developer Platform solution. It allows developers to write application logic, on AWS, without having to know how to provision and manage AWS services. Harmonix on AWS also allows platform engineering teams to easily manage all the resources and applications that run on AWS.
<br/>
#### What was the motivation behind building OPA on AWS?
#### What was the motivation behind building Harmonix on AWS?
>
> Enterprise are challenged to integrate with AWS while adhering to their standards, security guardrails and compliance. In addition, cloud engineers are a scarce resource that does not scale. Using platform engineering, this gap is shortened, thus enabling enterprise to improve their developer experience and scales the use of AWS Services securely.
<br/>
#### Is OPA on AWS an AWS Service?
#### Is Harmonix on AWS an AWS Service?
>
> No, OPA on AWS is not a managed service. It is an open source platform reference implementation supporting integration with AWS Services for enterprises. Since OPA on AWS is using native AWS Services, it provides all the benefits and scale that AWS can offer along with a productive developer experience
> No, Harmonix on AWS is not a managed service. It is an open source platform reference implementation supporting integration with AWS Services for enterprises. Since Harmonix on AWS is using native AWS Services, it provides all the benefits and scale that AWS can offer along with a productive developer experience
<br/>
#### Who is the audience for OPA on AWS?
#### Who is the audience for Harmonix on AWS?
>
> OPA on AWS binds the AWS services into an enterprise ready offering. It was originally built for financial enterprise use cases to accommodate for security and regulatory compliance needs and the necessity for scale and efficiency. It is applicable for every company interested in scaling while still keeping the same tooling and additional internal and external standards.
> Harmonix on AWS binds the AWS services into an enterprise ready offering. It was originally built for financial enterprise use cases to accommodate for security and regulatory compliance needs and the necessity for scale and efficiency. It is applicable for every company interested in scaling while still keeping the same tooling and additional internal and external standards.
<br/>
#### What support do you offer? How can I learn to use OPA on AWS?
#### What support do you offer? How can I learn to use Harmonix on AWS?
>
> OPA on AWS is accompanied with documentation, detailed ReadMes, and a series of YouTube videos. All of these resources can help you learn more about the solution and get started. For any issue beyond the current available information, you can reach us by [opening an issue via GitHub](https://github.com/awslabs/app-development-for-backstage-io-on-aws/issues)
> Harmonix on AWS is accompanied with documentation, detailed ReadMes, and a series of YouTube videos. All of these resources can help you learn more about the solution and get started. For any issue beyond the current available information, you can reach us by [opening an issue via GitHub](https://github.com/awslabs/harmonix/issues)
<br/>
#### What is OPA on AWS’s license?
#### What is Harmonix on AWS’s license?
>
> OPA on AWS is licensed as Apache-2.0.
> Harmonix on AWS is licensed as Apache-2.0.
<br/>

#### What are the benefits for using OPA?
#### What are the benefits for using Harmonix?
>
> A better developer experience and faster way to scale the use of AWS Services for enterprises. Please see the full [features page](features.md)
<br/>
#### What are the requirements to get started on OPA?
#### What are the requirements to get started on Harmonix?
>
> Please read our documentation [Getting started](getting-started/deploy-the-platform.md)
<br/>
#### What is the price of OPA?
#### What is the price of Harmonix on AWS?
>
> OPA on AWS is free open source project. However the use of AWS Services is as per the service pricing of each service you use
> Harmonix on AWS is free open source project. However the use of AWS Services is as per the service pricing of each service you use
<br/>

Expand All @@ -64,25 +64,25 @@ toc_max_heading_level: 4
<br/>

#### Why is OPA on AWS integrated with Backstage?
#### Why is Harmonix on AWS integrated with Backstage?
>
> Backstage.io is a mature [CNCF project](https://www.cncf.io/projects/backstage/), and has been widely adopted across the market. By integrating with Backstage.io, users of OPA on AWS can benefit from +100 plugins and a large community (+20k). This allows customers to customize their environments, and keep existing tooling, while still working on AWS. Building on Backstage.io has helped to expedite the journey of OPA on AWS, and bring more value to our customers.
> Backstage.io is a mature [CNCF project](https://www.cncf.io/projects/backstage/), and has been widely adopted across the market. By integrating with Backstage.io, users of Harmonix on AWS can benefit from +100 plugins and a large community (+20k). This allows customers to customize their environments, and keep existing tooling, while still working on AWS. Building on Backstage.io has helped to expedite the journey of Harmonix on AWS, and bring more value to our customers.
<br/>
#### How can OPA on AWS accelerate applications migration?
#### How can Harmonix on AWS accelerate applications migration?
>
> Please see our [Migration page](migrations/overview.md)
<br/>

#### What happens if Backstage.io releases an update? How will OPA on AWS accommodate updates?
#### What happens if Backstage.io releases an update? How will Harmonix on AWS accommodate updates?
>
> OPA on AWS lists the latest tested version of Backstage.io with OPA on AWS plugins. The solution is decoupled from Backstage.io, therefore it should be possible to upgrade backstage and install the plugins afterwards. However, Backstage.io may introduce breaking changes and therefore we publish the last tested plugin version.
> Harmonix on AWS lists the latest tested version of Backstage.io with Harmonix on AWS plugins. The solution is decoupled from Backstage.io, therefore it should be possible to upgrade backstage and install the plugins afterwards. However, Backstage.io may introduce breaking changes and therefore we publish the last tested plugin version.
<br/>
#### How can I report bugs or submit feature requests?
>
> Please submit any issues and requests via the [public repository](https://github.com/awslabs/app-development-for-backstage-io-on-aws/issues)
> Please submit any issues and requests via the [public repository](https://github.com/awslabs/harmonix/issues)
<br/>
#### Will AWS supply templates or examples? How will they be maintained?
Expand All @@ -92,7 +92,7 @@ toc_max_heading_level: 4
#### Will this make the DevOps team obsolete?
>
> OPA on AWS helps scale DevOps teams and enables the development teams to own their infrastructure and applications and reduce the bottleneck from the DevOps team.
> Harmonix on AWS helps scale DevOps teams and enables the development teams to own their infrastructure and applications and reduce the bottleneck from the DevOps team.
<br/>
#### How secure is this solution? Has it been reviewed by a third party?
Expand All @@ -101,17 +101,17 @@ toc_max_heading_level: 4
<br/>

#### How does OPA on AWS differ from AWS console?
#### How does Harmonix on AWS differ from AWS console?
>
> OPA on AWS aims to provide a productive, efficient, and delightful developer experience by providing a simplified way to use AWS. By nature, the AWS console will enable the skilled cloud engineer to fine-tune and define their needs, however, OPA on AWS will enable a persona to build on AWS without having to know how to operate all the knobs and dials.
> Harmonix on AWS aims to provide a productive, efficient, and delightful developer experience by providing a simplified way to use AWS. By nature, the AWS console will enable the skilled cloud engineer to fine-tune and define their needs, however, Harmonix on AWS will enable a persona to build on AWS without having to know how to operate all the knobs and dials.
<br/>
#### What is an Internal Developing Platform (IDP)?
>
> Please refer to [platformengineering.org](https://platformengineering.org/blog/internal-developer-platforms-from-idea-to-reality)
<br/>
#### Does OPA on AWS have a CLI?
#### Does Harmonix on AWS have a CLI?
>
> Not yet - Please see [features](features.md)
<br/>
Expand Down
2 changes: 1 addition & 1 deletion website/docs/getting-started/_category_.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
"position": 2,
"link": {
"type": "generated-index",
"description": "Get started with deploying the OPA on AWS solution"
"description": "Get started with deploying the Harmonix on AWS solution"
}
}
Loading

0 comments on commit f75616b

Please sign in to comment.