Skip to content
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

Merged
merged 1 commit into from
Nov 28, 2016

Conversation

mcimbora
Copy link
Contributor

No description provided.

@mcimbora
Copy link
Contributor Author

@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.
Copy link
Contributor Author

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)

= 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.
Copy link

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
Copy link

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
Copy link

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.

Copy link

@jhrcek jhrcek left a 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`
Copy link

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?

@mcimbora
Copy link
Contributor Author

@jhrcek Thanks for the review, the comments have been addressed.

----
** User type: application user
** Username: planner
** Password: Planner123_
Copy link
Contributor

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.

Copy link
Contributor Author

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)

Copy link
Contributor

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">
Copy link
Contributor

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
Copy link
Contributor

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

= 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.
Copy link
Contributor

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.
Copy link
Contributor

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`
Copy link
Contributor

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)

@mcimbora
Copy link
Contributor Author

Thanks for the comments @vidya-iyengar, the PR has been updated. @ge0ffrey I think this is ready to go in.

@ge0ffrey ge0ffrey merged commit e93c987 into apache:master Nov 28, 2016
@@ -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.
Copy link
Contributor

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.

sterobin pushed a commit that referenced this pull request Aug 12, 2019
heathjoy pushed a commit that referenced this pull request Mar 31, 2021
…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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
6 participants