-
Notifications
You must be signed in to change notification settings - Fork 181
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
PLANNER-665: OptaPlanner Workbench Quick Start (tutorial for Cloud Balancing) #187
Conversation
@ge0ffrey Could you please have a look at this? |
@@ -0,0 +1,338 @@ | |||
= Cloud Balancing Example Setup | |||
|
|||
This chapter describes the process of setting up environment to run OptaCloud example using KIE Workbench and KIE Server. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A link to the OptaPlanner engine doc should be sufficient here (to reference CloudBalancing problem description)
4d2ddb8
to
2964cf9
Compare
= Cloud Balancing Example Setup | ||
|
||
This chapter describes the process of setting up environment to run OptaCloud example using KIE Workbench and KIE Server. | ||
At the end of the chapter user will be able to submit sample planning solution to the KIE Server and query the best solution. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
submit sample planning problem (instead of solution)?
+ | ||
[source,sh] | ||
---- | ||
$WILDFLY_HOME/bin/add_user.sh |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add-user.sh has '-', not '_'
+ | ||
[source,sh] | ||
---- | ||
./bin/standalone.sh --server-config=standalone-full.xml |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This command will not work "as is" - user's can't just copy-paste it. You can use '\' to make it into single multi-line command, like so:
./bin/standalone.sh --server-config=standalone-full.xml \
-Dorg.kie.server.user=planner \
etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just few minor comments, otherwise looks nice.
---- | ||
authorization: Basic cGxhbm5lcjpQbGFubmVyMTIzXw== | ||
X-KIE-ContentType: xstream | ||
content-type: application/xml` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it the ` character desired here?
2964cf9
to
bf23754
Compare
@jhrcek Thanks for the review, the comments have been addressed. |
---- | ||
** User type: application user | ||
** Username: planner | ||
** Password: Planner123_ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is a complex password needed? Or can we just use the same password as the username?
Real users shouldn't do this, but for demo's it lowers the barrier to entry.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ge0ffrey It follows password recommendations given by add-user
script shipped with WF.
- The password should be different from the username
- The password should not be one of the following restricted values {root, admin, administrator}
- The password should contain at least 8 characters, 1 alphabetic character(s), 1 digit(s), 1 non-alphanumeric symbol(s)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Those recommendations are optional, right? In either case, it's fine.
---- | ||
<solver-instance> | ||
<status>SOLVING</status> | ||
<planning-problem class="clouddepartment.cloudbalancing.CloudBalance" id="1"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are the XStream id attributes needed? (The id elements are needed).
A Quick start shouldn't include anything that can distract the new user.
|
||
=== Query Best Solution | ||
* `GET http://localhost:8080/kie-server/services/rest/server/containers/cloudbalancing/solvers/cloudBalancingSolver/bestsolution` | ||
** Verify that `computer` attributes of `CloudProcess` instances are assigned |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
grammar: "that the computer attributes
bf23754
to
6c293f4
Compare
6c293f4
to
1a9ff7a
Compare
= Cloud Balancing Example Setup | ||
|
||
This chapter describes the process of setting up environment to run https://docs.jboss.org/optaplanner/release/latestFinal/optaplanner-docs/html/ch02.html#cloudBalancingProblemDescription[Cloud Balancing] example using KIE Workbench and KIE Server. | ||
At the end of the chapter user will be able to submit sample planning problem to the KIE Server and query the best solution. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing comma: The statement should read: At the end of the chapter, the user will be able to submit sample planning problem to the KIE Server and query the best solution.
---- | ||
|
||
=== Open the Workbench in Browser | ||
Open the following URL `http://localhost:8080/kie-wb` in a web browser to access the Workbench. Use credentials defined in the previous step to log in. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can be simpler: Navigate to http://localhost:8080/kie-wb
in a web browser to access the Workbench.
The second step consists of setting up logical structures required to create a new project. | ||
|
||
=== Create Organizational Unit | ||
* `Authoring -> Administration -> Organizational Units -> Manage Organizational Units -> Add` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are we missing the word "Select" or "Navigate" here?
like: Select Authoring -> Administration -> Organizational Units -> Manage Organizational Units -> Add
OR
Navigate to Authoring -> Administration -> Organizational Units -> Manage Organizational Units
and click Add
(same issue with the other tasks below)
1a9ff7a
to
35f1717
Compare
Thanks for the comments @vidya-iyengar, the PR has been updated. @ge0ffrey I think this is ready to go in. |
@@ -0,0 +1,362 @@ | |||
= Cloud Balancing Example Setup | |||
|
|||
This chapter describes the process of setting up environment to run https://docs.jboss.org/optaplanner/release/latestFinal/optaplanner-docs/html/ch02.html#cloudBalancingProblemDescription[Cloud Balancing] example using KIE Workbench and KIE Server. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Broken link. s:/html/:/html_single/:
I'll submit a fix.
BXMSDOC-4516 PAM/DM 7.4.1 release notes
…onsole to business-central (#3408) * BXMSDOC-5977 changing approved instances of jbpm-console to business-central (#187) Co-authored-by: Michele Haglund <mhaglund@mhaglund.bos.csb> * BXMSDOC-5977 changing approved instances of jbpm-console to business-central Co-authored-by: Michele Haglund <mhaglund@mhaglund.bos.csb>
No description provided.