Skip to content

Commit

Permalink
chore: Update ide-setup.md (#2990)
Browse files Browse the repository at this point in the history
Changes only in md, tests were skipped.
docs: Changed the section detailing setup for IDEA Ultimate edition

Signed-off-by: matejpopda <20053580+matejpopda@users.noreply.github.com>
Co-authored-by: achmelo <37397715+achmelo@users.noreply.github.com>
  • Loading branch information
matejpopda and achmelo authored Jul 24, 2023
1 parent 5a15953 commit 3ffa275
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions docs/ide-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,31 @@ Guidelines relevant for development of the API Mediation Layer in the IntelliJ I

### Running of the services

These are the application main classes and their corresponding service names for configuration files:
- These are the application main classes and their corresponding service names for configuration files:
1. ApiCatalogApplication - api-catalog-service
2. DiscoverableClientSampleApplication - discoverable-client
3. DiscoveryServiceApplication - discovery-service
4. EnablerV1SampleApplication - onboarding-enabler-spring-sample-app
5. GatewayApplication - gateway-service
6. MockServicesApplication - mock-services

#### If using IDEA Ultimate Edition
- Go to 'Services', it is available via alt+8 or on the bottom line of the IDEA.
- There are no configuration files for:
1. CachingService
2. MetricsServiceApplication

- If you plan on using the [Dummy Authentication Provider](https://docs.zowe.org/stable/extend/extend-apiml/authentication-for-apiml-services/#dummy-authentication-provider) open the ./config/local/gateway-service.yml file and update `apiml.security.auth.provider:` to have value `dummy`

#### If using IDEA Ultimate Edition 2023
- Go to 'Services', it is available via alt+8 or on the bottom line of the IDEA.

For each of the available services:

1. Right click a service and select 'Edit Configuration' (or press F4 while the service is selected)
2. Clear all 'VM options' in the 'Environment' section
3. Then under the 'Override parameters' section add a new parameter `spring.config.additional-location` and its value `file:./config/local/{SERVICE_NAME}.yml` Replace SERVICE_NAME with the above service names.
4. Run the service
1. Right click a service and select 'Edit Configuration' (or press Shift + F4 while the service is selected)
2. Check that there are no set Environment variables (if you do not see the field you can press Alt + E or click on Modify options and select the Environment variables option from the list)
* For the Discovery service add Environment variable `spring.profiles.active` and it's value `https`
5. Then in the 'Override configuration properties' section (Alt + P or select it from the Modify options list again) add a new parameter `spring.config.additional-location` and its value `file:./config/local/{SERVICE_NAME}.yml` Replace SERVICE_NAME with the above service names.
6. Check that you are shortening the command line, Modify options -> Java -> Shorten command line and in the new field select JAR manifest.
7. Run the service

#### If using IDEA Community Edition

Expand Down

0 comments on commit 3ffa275

Please sign in to comment.