tiagobento commented on code in PR #2532: URL: https://github.com/apache/incubator-kie-tools/pull/2532#discussion_r1731514678
########## packages/sonataflow-management-console-webapp/README.md: ########## @@ -0,0 +1,59 @@ +# SonataFlow Management Console Webapp + +The Sonataflow Management Console Webapp is a production-ready web application designed for managing and monitoring serverless workflows. It includes security features such as user authentication integrating with Keycloak Server. + +## Enabling Keycloak security + +### Starting and Configuring the Keycloak Server + +To start a Keycloak Server you can use Docker and just run the following command: + +``` +docker run -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin -v ./dev/config/sonataflow-realm.json:/opt/keycloak/data/import/realm.json -p 8280:8080 quay.io/keycloak/keycloak:25.0.3 start-dev --import-realm +``` + +You should be able to access your Keycloak Server at [localhost:8280/auth](http://localhost:8280) +and verify keycloak server is running properly: log in as the admin user to access the Keycloak Administration Console. +Username should be admin and password admin. + +The following are the users available in keycloak + +| Login | Password | Roles | +| ----- | -------- | ------------------- | +| admin | admin | _admin_, _managers_ | +| alice | alice | _user_ | +| jdoe | jdoe | _managers_ | + +To change any of this client configuration access to http://localhost:8280/auth/admin/master/console/#/realms/sonataflow. + +### Changing configs + +Enable `PROD` env mode by running the app with: + +`SONATAFLOW_MANAGEMENT_CONSOLE_WEBAPP__sonataflowEnvMode=PROD pnpm dev` Review Comment: ```suggestion `SONATAFLOW_MANAGEMENT_CONSOLE_WEBAPP__sonataflowEnvMode=PROD pnpm start` ``` ? ########## packages/sonataflow-dev-app/README.md: ########## @@ -0,0 +1,37 @@ +# SonataFlow Dev App + +### Description + +The SonataFlow Dev App provides the SonataFlow GraphQL and OpenAPI endpoints. + +### Usage + +To run the development server, use the following command: Review Comment: ```suggestion To run the development app, use the following command: ``` ########## packages/sonataflow-management-console-webapp/resources/serverless-workflow-diagram-editor-envelope.html: ########## @@ -0,0 +1,42 @@ +<!-- + ~ Copyright 2022 Red Hat, Inc. and/or its affiliates. + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> Review Comment: Wrong copyright ########## packages/serverless-workflow-dev-ui-webapp/package.json: ########## @@ -22,7 +22,7 @@ "build:dev": "rimraf dist && webpack --env dev", "build:prod": "pnpm lint && rimraf dist && webpack", "dev": "concurrently 'pnpm start' 'pnpm run dev:server'", Review Comment: Not part of the changes, but deviating from the repo's conventions... Can you please adapt this and others too? Thanks! ########## packages/sonataflow-management-console-webapp/resources/serverless-workflow-combined-editor-envelope.html: ########## @@ -0,0 +1,42 @@ +<!-- + ~ Copyright 2022 Red Hat, Inc. and/or its affiliates. + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> Review Comment: Wrong copyright ########## packages/sonataflow-management-console-webapp/resources/serverless-workflow-text-editor-envelope.html: ########## @@ -0,0 +1,42 @@ +<!-- + ~ Copyright 2022 Red Hat, Inc. and/or its affiliates. + ~ + ~ Licensed under the Apache License, Version 2.0 (the "License"); + ~ you may not use this file except in compliance with the License. + ~ You may obtain a copy of the License at + ~ + ~ http://www.apache.org/licenses/LICENSE-2.0 + ~ + ~ Unless required by applicable law or agreed to in writing, software + ~ distributed under the License is distributed on an "AS IS" BASIS, + ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + ~ See the License for the specific language governing permissions and + ~ limitations under the License. + --> Review Comment: Wrong copyright ########## packages/sonataflow-management-console-image-env/README.md: ########## @@ -0,0 +1,44 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +## @kie-tools/sonataflow-management-console-image-env + +--- Review Comment: Previous comment was marked as resolved but there's no description here yet. ########## packages/sonataflow-dev-app/README.md: ########## @@ -0,0 +1,37 @@ +# SonataFlow Dev App + +### Description + +The SonataFlow Dev App provides the SonataFlow GraphQL and OpenAPI endpoints. Review Comment: I guess here is a good place to inform consumers that these endpoints are mocks and that this package is intended for development purposes only. ########## packages/sonataflow-deployment-webapp/package.json: ########## @@ -17,6 +17,8 @@ "scripts": { "build:dev": "rimraf dist && webpack --env dev", "build:prod": "pnpm lint && pnpm test && rimraf dist && webpack", + "dev": "concurrently 'pnpm start' 'pnpm run dev:server'", + "dev:server": "pnpm -F @kie-tools/sonataflow-dev-app start", Review Comment: As discussed previously, `start` is the actual conventioned command to spin up a package during development. Please adapt the existing `start` script. You can do `start:dev-webapp` and `start:sonataflow-dev-app` for example, and have `start` be `concurrently 'pnpm start:dev-webapp' 'pnpm start:sonataflow-dev-app'` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
