microsoft / spring-cloud-playground

Azure Spring Cloud Playground helps you scaffold and generate Microservice projects

Azure Spring Cloud Playground

Azure Spring Cloud Playground helps you scaffold and generate Microservice projects. It provides you with native Spring Cloud modules as well as modules developed for connecting to and consuming Azure related services. The generated Microservice projects follow The Twelve-Factor App methodology and are ready for further development with Azure Dev Spaces and Azure Kubernetes Service.

Getting Started

• Install Maven and Docker
• Access to azure-spring-cloud.azurewebsites.net
• Sign in with your Azure subscription if you want your Spring Cloud Azure modules to be configured. If you don't have a Azure subscription get a free one.
• Select the modules you'd like to start with and generate the project.
• You can run locally with docker compose. Extract and go to project root directory, run the following:

cd docker
run.cmd (run.sh)

• After all microservices start, access gateway endpoint at http://localhost:9999

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

spring-cloud-playground's Issues

Change customize config link to above next button

Use JPA with Sql module

Configured services delete button is confusing

The delete button at the front of service name looks like the service doesn't work, I think it is better to move delete button to the back of service name, like spring initializer.

Link to spring cloud azure repo

Allow user to see the spring cloud azure repo link easily on the homepage, e.g., a github repo badge

Gateway cannot access generated services from gateway portal

Caused by generated cloud-gateway.yml has wrong route url for service.

Generated:

      routes:
      - id: AzureServiceBusApplication
        uri: lb://AzureServiceBusApplication
        predicates:
        - Path=/AzureServiceBusApplication/**

Expected:

      routes:
      - id: AzureServiceBusApplication
        uri: lb://azure-service-bus
        predicates:
        - Path=/azure-service-bus/**

Add footer on the page

default service uri to localhost

e.g. spring.cloud.config.uri=http://localhost:8888. replace localhost to hostname in docker

Add an option to allow users to push to GitHub repo

After users finalize the microservice moduels, he/she can choose to push the project to a new GitHub repository. This may require users to login the GitHub.

create a aka.ms/playground for spring-cloud-playground

ideally have a FQDN for it.

Size of the two video frames are different

In last step, by default the generate button is not visible from the screen

In the select azure modules and generate project step, by default the generate and previous button does not show up.

Add test

e.g., test generate project

Change the name of Spring Cloud/Boot Azure Starters

• Azure Event Hub // Spring Cloud Stream Binder for Azure Event Hub
• Azure Storage // Spring Resource with Azure Storage
• Azure Cosmos DB // Spring Data Azure Cosmos DB (SQL API)
• Azure Redis Cache // Spring Caching with Azure Redis Cache
• Azure Active Directory // Spring Security with Azure Active Directory
• Azure Key Vault // Spring Boot with Azure Key Vault

set up CICD to azure web app

404 error when accessing http://localhost:8080/storage

Remove value = "/". The path in @RequestMapping on the method is relative to the path on the class annotation.

@RequestMapping(value = "/", method = RequestMethod.GET)
public String readBlobFile() throws IOException {
    return StreamUtils.copyToString(
            this.blobFile.getInputStream(),
            Charset.defaultCharset()) + "\n";
}

https://github.com/Microsoft/spring-cloud-playground/blob/72e33e68329c1f767a341f5a172b003951ae404f/src/main/resources/templates/azure-storage/StorageController.java#L23

spring data jpa doesn't work

1. jpa dependency needs to be added manually - against the description of sql module
2. data not written into the db.

redis cache module needs to be tested

it's not covered in test as far as i know. could be a big issue.

rectify `# Leave username empty if database server already created`

still see this in the generated project:

Leave username empty if database server already created

Improve video to be more meaningful

Consider whether users need to watch the video and why we need the video here.

Deployment guideline page

3 different deploy guidelines are provided.

remove login

Support docker compose file auto generation when new modules added

Docker compose should be generic enough to support each service define by Service metadata

docker login operation only works when deployment

azure storage and sql in one microservice result in bean dependency cycle

The dependencies of some of the beans in the application context form a cycle:

   servletEndpointRegistrar defined in class path resource [org/springframework/boot/actuate/autoconfigure/endpoint/web/ServletEndpointManagementContextConfiguration$WebMvcServletEndpointManagementContextConfiguration.class]
      ↓
   healthEndpoint defined in class path resource [org/springframework/boot/actuate/autoconfigure/health/HealthEndpointConfiguration.class]
      ↓
   org.springframework.boot.actuate.autoconfigure.jdbc.DataSourceHealthIndicatorAutoConfiguration
┌─────┐
|  dataSource
↑     ↓
|  scopedTarget.dataSource defined in class path resource [org/springframework/boot/autoconfigure/jdbc/DataSourceConfiguration$Hikari.class]
↑     ↓
|  org.springframework.boot.autoconfigure.jdbc.DataSourceInitializerInvoker

Generate Azure related Service failure.

Add unit test to compare generated zip with expected zip

add easy get-started in home page

Add link to guide users about how to fire issues and get support

restriction for service name and port

In select azure modules step, the service name and port is configurable, but no restriction for input value

eliminate unnecessary http request to spring.io

the boot data rarely changes, we can make it constant for now.

Fetching boot metadata from https://spring.io/project_metadata/spring-boot
Fetching boot metadata from https://spring.io/project_metadata/spring-boot
Fetching boot metadata from https://spring.io/project_metadata/spring-boot

separate navigation header to another template

As header will be shown for every page, in order to reuse the navigation header, separate header to a standalone template. Expected sample result:

Homepage:

<html>
   <head>omitted</head>
   <body>
          {{> header}}
          {{> home}}
   </body>
</html>

Deploy page:

<html>
   <head>omitted</head>
   <body>
          {{> header}}
          {{> deploy}}
   </body>
</html>

Abstract the Spring Cloud Azure Playground as a customized Spring Initializr endpoint.

Developers can choose to use it on Playground Portal, or use it where supports Spring Initailizr (as a customized URL).

change `modules` to `module(s)`

if users just select one module, playground still says modules rather module. Suggest change wording to module(s).

e.g.
cloud-config-server, modules: cloud-config-server, port: 8888

Add BI for push-to-github and github login

incorrect tab index order on the page

Some tab indexes are conflicting and order is incorrect.

Azure module example classes should be put in different directory

In the generated azure module, all the example controllers, models and repositories are in a single directory.
It is better to separate them into each directory.

configured ports are not displayed at step 3

Configured services' port like this:

But step 3 still shows default port:

rename kubernetes.yaml to kubernetes.yml for consistency

1. rename
2. test if kuberctl apply works

Use Post http request to backend

Project request should sent POST request with Json body to backend.

Content-Type: application/json

{
	"name":"demo",
	"type":"maven-project",
	"groupId":"com.example",
	"artifactId":"demo",
	"version": "0.0.1-SNAPSHOT",
	"bootVersion":"2.0.3.RELEASE",
	"language":"java",
	"packageName":"com.example.demo",
	"javaVersion":"1.8",
	"baseDir":"demo",
	"packaging": "pom",
	"description": "Project for spring cloud on azure",
	"microServices":[
		{
			"name":"cloud-config-server",
			"modules": ["cloud-config-server"],
			"port": 8888
		},
		{
			"name":"cloud-eureka-server",
			"modules": ["cloud-eureka-server"],
			"port": 8761
		},
		{
			"name":"cloud-gateway",
			"modules": ["cloud-gateway"],
			"port": 9999
		},
		{
			"name":"azure-service-bus",
			"modules": ["azure-service-bus"],
			"port": 8081
		},
		{
			"name":"cloud-hystrix-dashboard",
			"modules": ["cloud-hystrix-dashboard"],
			"port": 7979
		}
	]
}

Missing .sql file for Sql module

configure port to generated Microservice should be allowed

• ProjectRequest should contain the configured port.
• Port conflict should be detected and there should be a fallback mechanism.

Support to add service's property easily when add new module

add boot starters to playground including sample code

Test the BOM for Spring Cloud/Boot Azure starters generated with Playground

Test the compile and runtime status when selecting all Azure starters from Playground.

Support to generate sample based on module specific template

select infra modules by default

Some infra modules are must, so by default it should be selected.

Reset to default configuration is confusing

The reset to default configuration link is confusing, from the link description, sounds like port will be reset to default value, but actually it's hide port configuration.

figure out what 'initial' code should look like for all Azure modules

Includes:

• how to subscribe to interest in eureka and how to discover other services
• implement a sample API etc.

change logo to the latest one

figure out what BI we'll be collecting