Skip to content
This repository has been archived by the owner on Jul 27, 2023. It is now read-only.

704 document quick start removal #728

Merged
merged 3 commits into from
Apr 14, 2020
Merged

704 document quick start removal #728

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96c0504
704 document quick start security removal on deployment
uberskigeek Mar 23, 2020
edc6a58
java-microprofile: document quick start security removal
uberskigeek Mar 23, 2020
605be40
java-microprofile: Notify of quick start security removal
uberskigeek Apr 14, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions incubator/java-microprofile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@ OpenAPI endpoints:
- http://localhost:9080/openapi (the RESTful APIs of the inventory service)
- http://localhost:9080/openapi/ui (Swagger UI of the deployed APIs)

### Config dropin: **quick-start-security.xml**

The metrics endpoint is secured with a userid and password enabled through the config dropin included in the default template at path:
**src/main/liberty/config/configDropins/defaults/quick-start-security.xml**.

In order to lock down the production image built via `appsody build` this file is deleted during the Docker build of your application production image. (The same file would be deleted if you happened to create your own file at this location as well).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

An instruction should be provided on how to provide userid and password to access the metrics endpoint.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be addressed by #750

## Getting Started

1. Create a new folder in your local directory and initialize it using the Appsody CLI, e.g.:
Expand Down Expand Up @@ -74,6 +81,8 @@ OpenAPI endpoints:
- Swagger UI endpoint: http://localhost:9080/openapi/ui
- Javametrics Dashboard endpoint: http://localhost:9080/javametrics-dash/ (development-time only)



## License

This stack is licensed under the [Apache 2.0](./image/LICENSE) license
1 change: 1 addition & 0 deletions incubator/java-microprofile/image/project/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ RUN cd /project/user-app && mvn -B liberty:install-server
# Remove quick-start-security.xml since it is only needed during local development.
COPY ./user-app/src /project/user-app/src
RUN cd /project/user-app && \
echo "QUICK START SECURITY IS NOT SECURE FOR PRODUCTION ENVIRONMENTS. IT IS BEING REMOVED" \
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we add this too to java-openliberty ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok I'll add it there.

rm -f src/main/liberty/config/configDropins/defaults/quick-start-security.xml && \
mvn package -DskipTests

Expand Down
4 changes: 2 additions & 2 deletions incubator/java-microprofile/stack.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: Eclipse MicroProfile®
version: 0.2.24
version: 0.2.25
description: Eclipse MicroProfile on Open Liberty & OpenJ9 using Maven
license: Apache-2.0
language: java
Expand All @@ -17,4 +17,4 @@ default-template: default
requirements:
appsody-version: ">= 0.5.0"
templating-data:
libertyversion: '19.0.0.12'
libertyversion: '19.0.0.12'