Skip to content

Commit

Permalink
Merge pull request #219 from electric-cloud/BEE-16076
Browse files Browse the repository at this point in the history 
Update the documentation
  • Loading branch information
@valpere
valpere authored Mar 9, 2022
2 parents 1dd9dc8 + ffd7734 commit 025144d
Show file tree
Hide file tree
Showing 60 changed files with 1,292 additions and 2,519 deletions.
2,876 changes: 769 additions & 2,107 deletions help/help.adoc
View file

Large diffs are not rendered by default.

68 changes: 34 additions & 34 deletions pages/EC-WebLogic_help.xml
View file

Large diffs are not rendered by default.

27 changes: 15 additions & 12 deletions src/main/resources/project/WebLogicCreateConfigForm.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,15 +19,15 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>Configuration Name:</label>
<label>Configuration name</label>
<property>config</property>
<value></value>
<required>1</required>
</formElement>

<formElement>
<type>entry</type>
<label>WebLogic URL:</label>
<label>WebLogic URL</label>
<property>weblogic_url</property>
<value></value>
<documentation>URL of WebLogic Server (must include protocol, server and port). Two protocols are supported: t3 and t3s, e.g. t3://weblogic:7001.</documentation>
Expand All @@ -36,16 +36,19 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>WLST Script Absolute Path:</label>
<label>WLST script absolute path</label>
<property>wlst_path</property>
<value></value>
<documentation>Absolute path to WLST. i.e: '/path/to/wlst.cmd' or 'wlst.sh'. Setting this path will make applying the equal param in procedures unnecessary.</documentation>
<documentation>
Absolute path to WLST. i.e: '/path/to/wlst.cmd' or 'wlst.sh'. Setting this path will make applying the equal param in procedures unnecessary.
NOTE: You need to install the agent to the machine that has access to the WLST script at least.
</documentation>
<required>1</required>
</formElement>

<formElement>
<type>entry</type>
<label>JAVA_HOME:</label>
<label>JAVA_HOME</label>
<property>java_home</property>
<value></value>
<documentation>JAVA_HOME environment variable, i.e. path to bin, where java executable is located. This variable will be set every time procedure runs for the job environment. Warning: the behaviour of the procedure can become unpredictable, if the same resource is shared across multiple EF instances. If this option is set, JAVA_VENDOR should be also set.</documentation>
Expand All @@ -54,7 +57,7 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>JAVA_VENDOR:</label>
<label>JAVA_VENDOR</label>
<property>java_vendor</property>
<value></value>
<documentation>JAVA_VENDOR environment variable, use it to specify java vendor. This variable will be set every time procedure runs for the job environment. Warning: the behaviour of the procedure can become unpredictable, if the same resource is shared across multiple EF instances. If this option is set, the option JAVA_HOME should be also set. </documentation>
Expand All @@ -63,7 +66,7 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>MW_HOME:</label>
<label>MW_HOME</label>
<property>mw_home</property>
<value></value>
<documentation>MW_HOME environment variable, use it to specify WebLogic Home directory. This variable will be set every time procedure runs for the job environment. Warning: the behaviour of the procedure can become unpredictable, if the same resource is shared across multiple EF instances.</documentation>
Expand All @@ -72,7 +75,7 @@ limitations under the License.

<formElement>
<type>credential</type>
<label>Login as:</label>
<label>Login as</label>
<property>credential</property>
<value></value>
<required>0</required>
Expand All @@ -82,7 +85,7 @@ limitations under the License.

<formElement>
<type>checkbox</type>
<label>Enable named sessions?:</label>
<label>Enable named sessions?</label>
<property>enable_named_sessions</property>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
Expand All @@ -95,7 +98,7 @@ limitations under the License.

<formElement>
<type>checkbox</type>
<label>Test Connection?:</label>
<label>Test connection?</label>
<property>test_connection</property>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
Expand All @@ -105,7 +108,7 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>Test Connection Resource:</label>
<label>Test connection resource</label>
<property>test_connection_res</property>
<value></value>
<documentation>A resource which is used for the testing connection.</documentation>
Expand All @@ -116,7 +119,7 @@ limitations under the License.

<formElement>
<type>select</type>
<label>Debug level:</label>
<label>Debug level</label>
<property>debug_level</property>
<value>0</value>
<documentation>Debug level, higher debug level - more debug messages. Warning: on debug level 10 and more passwords will be revealed in a procedure logs.</documentation>
Expand Down
23 changes: 13 additions & 10 deletions src/main/resources/project/WebLogicCreateConfigFormNew.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>WebLogic URL:</label>
<label>WebLogic URL</label>
<property>weblogic_url</property>
<value></value>
<documentation>URL of WebLogic Server (must include protocol, server and port). Two protocols are supported: t3 and t3s, e.g. t3://weblogic:7001.</documentation>
Expand All @@ -28,16 +28,19 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>WLST Script Absolute Path:</label>
<label>WLST script absolute path</label>
<property>wlst_path</property>
<value></value>
<documentation>Absolute path to WLST. i.e: '/path/to/wlst.cmd' or 'wlst.sh'. Setting this path will make applying the equal param in procedures unnecessary.</documentation>
<documentation>
Absolute path to WLST. i.e: '/path/to/wlst.cmd' or 'wlst.sh'. Setting this path will make applying the equal param in procedures unnecessary.
NOTE: You need to install the agent to the machine that has access to the WLST script at least.
</documentation>
<required>1</required>
</formElement>

<formElement>
<type>entry</type>
<label>JAVA_HOME:</label>
<label>JAVA_HOME</label>
<property>java_home</property>
<value></value>
<documentation>JAVA_HOME environment variable, i.e. path to bin, where java executable is located. This variable will be set every time procedure runs for the job environment. Warning: the behaviour of the procedure can become unpredictable, if the same resource is shared across multiple EF instances. If this option is set, JAVA_VENDOR should be also set.</documentation>
Expand All @@ -46,7 +49,7 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>JAVA_VENDOR:</label>
<label>JAVA_VENDOR</label>
<property>java_vendor</property>
<value></value>
<documentation>JAVA_VENDOR environment variable, use it to specify java vendor. This variable will be set every time procedure runs for the job environment. Warning: the behaviour of the procedure can become unpredictable, if the same resource is shared across multiple EF instances. If this option is set, the option JAVA_HOME should be also set. </documentation>
Expand All @@ -55,7 +58,7 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>MW_HOME:</label>
<label>MW_HOME</label>
<property>mw_home</property>
<value></value>
<documentation>MW_HOME environment variable, use it to specify WebLogic Home directory. This variable will be set every time procedure runs for the job environment. Warning: the behaviour of the procedure can become unpredictable, if the same resource is shared across multiple EF instances.</documentation>
Expand All @@ -64,7 +67,7 @@ limitations under the License.

<formElement>
<type>credential</type>
<label>Login as:</label>
<label>Login as</label>
<property>credential</property>
<value></value>
<required>0</required>
Expand All @@ -74,7 +77,7 @@ limitations under the License.

<formElement>
<type>checkbox</type>
<label>Enable named sessions?:</label>
<label>Enable named sessions?</label>
<property>enable_named_sessions</property>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
Expand All @@ -87,7 +90,7 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>Test Connection Resource:</label>
<label>Test connection resource</label>
<property>test_connection_res</property>
<value></value>
<documentation>A resource which is used for the testing connection.</documentation>
Expand All @@ -96,7 +99,7 @@ limitations under the License.

<formElement>
<type>select</type>
<label>Debug level:</label>
<label>Debug level</label>
<property>debug_level</property>
<value>0</value>
<documentation>Debug level, higher debug level - more debug messages. Warning: on debug level 10 and more passwords will be revealed in a procedure logs.</documentation>
Expand Down
25 changes: 14 additions & 11 deletions src/main/resources/project/WebLogicEditConfigForm.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>WebLogic URL:</label>
<label>WebLogic URL</label>
<property>weblogic_url</property>
<value></value>
<documentation>URL of WebLogic server (must include protocol, server and port).</documentation>
Expand All @@ -28,16 +28,19 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>WLST Script Absolute Path:</label>
<label>WLST script absolute path</label>
<property>wlst_path</property>
<value></value>
<documentation>Absolute path to WLST. i.e: '/path/to/wlst.cmd' or 'wlst.sh'. Setting this path will make applying the equal param in procedures unnecessary.</documentation>
<documentation>
Absolute path to WLST. i.e: '/path/to/wlst.cmd' or 'wlst.sh'. Setting this path will make applying the equal param in procedures unnecessary.
NOTE: You need to install the agent to the machine that has access to the WLST script at least.
</documentation>
<required>1</required>
</formElement>

<formElement>
<type>entry</type>
<label>JAVA_HOME:</label>
<label>JAVA_HOME</label>
<property>java_home</property>
<value></value>
<documentation>JAVA_HOME environment variable, i.e. path to bin, where java executable is located. This variable will be set every time procedure runs for the job environment. Warning: the behaviour of the procedure can become unpredictable, if the same resource is shared across multiple EF instances. If this option is set, JAVA_VENDOR should be also set.</documentation>
Expand All @@ -46,7 +49,7 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>JAVA_VENDOR:</label>
<label>JAVA_VENDOR</label>
<property>java_vendor</property>
<value></value>
<documentation>JAVA_VENDOR environment variable, use it to specify java vendor. This variable will be set every time procedure runs for the job environment. Warning: the behaviour of the procedure can become unpredictable, if the same resource is shared across multiple EF instances. If this option is set, the option JAVA_HOME should be also set.</documentation>
Expand All @@ -55,7 +58,7 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>MW_HOME:</label>
<label>MW_HOME</label>
<property>mw_home</property>
<value></value>
<documentation>MW_HOME environment variable, use it to specify WebLogic Home directory. This variable will be set every time procedure runs for the job environment. Warning: the behaviour of the procedure can become unpredictable, if the same resource is shared across multiple EF instances.</documentation>
Expand All @@ -64,7 +67,7 @@ limitations under the License.

<formElement>
<type>credential</type>
<label>Login as:</label>
<label>Login as</label>
<property>credential</property>
<value></value>
<required>0</required>
Expand All @@ -74,7 +77,7 @@ limitations under the License.

<formElement>
<type>checkbox</type>
<label>Enable named sessions?:</label>
<label>Enable named sessions?</label>
<property>enable_named_sessions</property>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
Expand All @@ -87,7 +90,7 @@ limitations under the License.

<formElement>
<type>checkbox</type>
<label>Test Connection?:</label>
<label>Test connection?</label>
<property>test_connection</property>
<checkedValue>1</checkedValue>
<uncheckedValue>0</uncheckedValue>
Expand All @@ -97,7 +100,7 @@ limitations under the License.

<formElement>
<type>entry</type>
<label>Test Connection Resource:</label>
<label>Test connection resource</label>
<property>test_connection_res</property>
<value></value>
<documentation>A resource which is used for the testing connection.</documentation>
Expand All @@ -108,7 +111,7 @@ limitations under the License.

<formElement>
<type>select</type>
<label>Debug Level:</label>
<label>Debug Level</label>
<property>debug_level</property>
<value>0</value>
<documentation>Debug level, higher debug level - more debug messages. Warning: on debug level 10 and more passwords will be revealed in a procedure logs.</documentation>
Expand Down
2 changes: 1 addition & 1 deletion src/main/resources/project/lib/EC/WebLogic.pm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -741,7 +741,7 @@ sub configurationErrorWithSuggestions {

my $suggestions = q{Reasons could be due to one or more of the following. Please ensure they are correct and try again.:
1. WebLogic URL - Is your URL complete and reachable?
2. WLST Script Absolute Path - Is your Path to the Script correct?
2. WLST script absolute path - Is your path to the script correct?
3. Test Resource - Is your Test resource correctly wired with CloudBees CD? Is your Test Resource correctly setup with WebLogic?
4. Credentials - Are your credentials correct? Are you able to use these credentials to log in to WebLogic using its console?
};
Expand Down
13 changes: 8 additions & 5 deletions src/main/resources/project/parameterForms/ec_parameterForm-AddServerToCluster.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,19 @@
<help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-weblogic#AddServerToCluster</help>
<formElement>
<type>entry</type>
<label>WLST Absolute Path:</label>
<label>WLST script absolute path</label>
<property>wlst_abs_path</property>
<required>0</required>
<documentation>Absolute path to WLST. i.e: '/path/to/wlst.cmd' or 'wlst.sh'.</documentation>
<documentation>
Absolute path to WLST. i.e: '/path/to/wlst.cmd' or 'wlst.sh'. Setting this path will make applying the equal param in procedures unnecessary.
NOTE: You need to install the agent to the machine that has access to the WLST script at least.
</documentation>
<propertyReference type="property">/plugins/@PLUGIN_NAME@/project/weblogic_cfgs/$configname/wlst_path</propertyReference>
<dependsOn>configname</dependsOn>
</formElement>
<formElement>
<type>entry</type>
<label>Configuration Name:</label>
<label>Configuration name</label>
<!-- Improvements for CEV-18687 -->
<configuration>1</configuration>
<!-- End of improvements for CEV-18687 -->
Expand All @@ -40,14 +43,14 @@
</formElement>
<formElement>
<type>entry</type>
<label>Server Name:</label>
<label>Server name</label>
<property>server_name</property>
<documentation>Name of the server which is to be added to cluster.</documentation>
<required>1</required>
</formElement>
<formElement>
<type>entry</type>
<label>Cluster Name:</label>
<label>Cluster name</label>
<property>cluster_name</property>
<documentation>Name of the cluster in which server is to be added.</documentation>
<required>1</required>
Expand Down
17 changes: 10 additions & 7 deletions src/main/resources/project/parameterForms/ec_parameterForm-AddUserToGroup.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,19 @@
<help>https://docs.cloudbees.com/docs/cloudbees-cd/latest/plugins/ec-weblogic#AddUserToGroup</help>
<formElement>
<type>entry</type>
<label>WLST Absolute Path:</label>
<label>WLST script absolute path</label>
<property>wlst_abs_path</property>
<required>0</required>
<documentation>Absolute path to WLST. i.e: '/path/to/wlst.cmd' or 'wlst.sh'.</documentation>
<documentation>
Absolute path to WLST. i.e: '/path/to/wlst.cmd' or 'wlst.sh'. Setting this path will make applying the equal param in procedures unnecessary.
NOTE: You need to install the agent to the machine that has access to the WLST script at least.
</documentation>
<propertyReference type="property">/plugins/@PLUGIN_NAME@/project/weblogic_cfgs/$configname/wlst_path</propertyReference>
<dependsOn>configname</dependsOn>
</formElement>
<formElement>
<type>entry</type>
<label>Configuration Name:</label>
<label>Configuration name</label>
<!-- Improvements for CEV-18687 -->
<configuration>1</configuration>
<!-- End of improvements for CEV-18687 -->
Expand All @@ -40,28 +43,28 @@
</formElement>
<formElement>
<type>entry</type>
<label>User Name:</label>
<label>User name</label>
<property>user_name</property>
<documentation>Name of the user to be added.</documentation>
<required>1</required>
</formElement>
<formElement>
<type>entry</type>
<label>Group Name:</label>
<label>Group name</label>
<property>group_name</property>
<documentation>Name of the group in which user is to be added.</documentation>
<required>1</required>
</formElement>
<formElement>
<type>entry</type>
<label>Domain Name:</label>
<label>Domain name</label>
<property>domain_name</property>
<documentation>Name of the user domain.</documentation>
<required>1</required>
</formElement>
<formElement>
<type>entry</type>
<label>Realm Name:</label>
<label>Realm name</label>
<property>realm_name</property>
<documentation>Name of the user realm.</documentation>
<required>1</required>
Expand Down
Loading

0 comments on commit 025144d

Please sign in to comment.