Administering Moves
The entities that need to be administered for moves are listed below.
In general you should set entities up in the order that they appear above. The entities are described in detail below.
Repositories
Repositories are maven repositories, accessible to moves over http/https. An example is the the SAIS Group repository at https://mv-ezproxy-com.ezproxyberklee.flo.org/nexus/content/groups/saisGroupRepo. Maven has a well defined format, which specifies where to find an application within a repository. Each Application has an 'ArtifactId', a 'GroupId' and a 'Version'. So, for example, moves itself has artifactId=sais-moves-web, groupId=edu.mit.ist.es, versionId=2.0.0. Maven will translate this, by default into a final location of https://mv-ezproxy-com.ezproxyberklee.flo.org/nexus/content/groups/saisGroupRepo/edu/mit/ist/es/sais-moves-web/2.0.0/sais-moves-web-2.0.0.war
" The properties you need to configure for a repository are:
- server (e.g. maven.mit.edu)
- port (e.g. null - if port is null, moves uses the default port for the protocol supplied)
- protocol (e.g. https)
- base url (e.g. /nexus/content/groups/saisGroupRepo)
The base url can contain the following replacement properties.
Property Name |
Description |
||
---|---|---|---|
${groupId} |
replaced with the groupId of the application being deployed |
||
${artifactId} |
replaced with the artifactId of the application being deployed |
||
${version} |
replaced with the version of the application being deployed |
||
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="73cde9c9-1e17-4eaf-9171-e9012bb0b18c"><ac:plain-text-body><![CDATA[ |
${app.[paramName]} |
replaced with the parameter value with key 'paramName' of the application being deployed |
]]></ac:plain-text-body></ac:structured-macro> |
The values for all parameters except 'version' are specified in the Administration -> Stacks -> Application section of moves. The version is selected during the deploy/build workflows by the user who has requested a deploy/build workflow.
Note that in order to access the MIT repository, you must also have correctly configured SSL access and a Maven username and password that is authorized to view the repository you have configured. See the properties webservices.trustStore, webservices.trustStorePassword, mit.maven.repository.username and mit.maven.repository.password as described in the page Moves Property File settings for details.
Note that when you have configured an app that has at least one release in the MIT repository, you can test repository connectivity by going to Administration -> Stacks and clicking on the 'ping app' icon (
If your app and repository are configured correctly, versions that exist in Maven should appear on the resulting page. You should be able to click on the download icon (
If you cannot download an application using this test, you will NOT be able to deploy that application using Moves!!!
Environments
Environments are really just a lookup that identifies the function of containers within a stack. The standard environments are 'Production', 'QA', and 'Development'. These are already set up when Moves is deployed, so they will not need to be changed. However, we allow creation of new future environments (for example 'Continuous Integration' or 'Staging'). Note that the property file may need to be edited (and the moves application restarted). See the section 'Oracle Application Server usernames and passwords' in Moves Property File settings.
Stacks
A Stack is simply a grouping of Applications and Containers by Environment. Stacks allow Moves to answer the question 'What is the container for Application 'X' in Environment 'Y'. Once you create a Stack, you can add containers to it for each environment. When we subsequently configure an application, we will tell it what Stack is associated with that application. (So, for example, the application 'OGS Application' might reference 'OGS Stack'. 'OGS Stack' references containers for 'Production', 'QA', and 'Development'). By looking at these relationships, Moves knows which container to deploy to when asked to deploy to a particular environment.
Containers
A container is the service that an application is deployed to. When you configure a new Container, you will be asked to select from one of the container types. The two container types that are currently available are
- OC4J Container (deploys to Oc4j containers)
- Mock Container (does nothing, used to test workflows)
In the future we will implement other containers according to MIT needs (tomcat/weblogic etc).
For the Oc4j container, the deployerUrl must be configured. This is the url you would normally type if you are manually deploying an application using the oracle admin_client.jar utility. Typically you will use a deployerUrl of the form deployer:oc4j:opmn://server-name:port-number/application-name for OAS clusters. You will use a deployerUrl of the form deployer:oc4j:localhostserver-name for OAS standalone instances. The deployment process essentially just runs the admin_client program. Below is the configuration page for containers.
Moves will need to know
- Where is your oc4j home directory (so it can locate the admin_client.jar program)
- What is the deployer url for the cluster (or standalone instance)
- What is the username and password to use for the target container
The following checklist should help you successfully configure a container.
- Start off by making sure you have network access between the Moves Server and the Container you wish to deploy to. (For non-local deployments you will need the IS&T infrastructure team to complete these steps).
- open a shell on the machine where Moves is running.
- cd to the ORACLE_HOME folder for this machine (typically /home/oracle/product/10.1.3/j2ee/home)
type java -jar admin_client.jar [deployerUrl] [oc4j-admin-username] [oc4j-admin-password] -listApplications. You should see a list of zero or more applications. You MUST be able to execute this step without getting errors before even bothering returning to Moves!!! The most common sources of error here are no network connection (firewall or ipconfig issues), bad usernames/passwords, incorrect deployer urls.
- Upon completion of this step, make a note of the deployerUrl, oc4j-admin-username and oc4j-admin-password.
- For the environment type that you will be using, verify that the oracle username and password found in the previous step are correctly set up in the properties file. See Moves Property File settings, specifically the section 'Oracle Application Server usernames and passwords'.
- On the Administration->Stacks->Container page, make sure the environment type is correctly set, and that the deployerUrl matches the previous step.
- Save the container, and click on the "container ping" icon for that container ( ). The page should list the same applications as were listed in the prior step. If you get errors with this page, go back and verify everything in the prior steps.
Applications
Applications represent web apps (.war or .ear applications) that can be deployed to a container. Application configuration is used to
- Find released applications in maven
- Deploy applications to a container
The following screen shot shows the parameters used for the Template Web Application.
Removing Artifacts
TODO: removing artifacts is not implemented through the UI yet.
A utility exists within the Moves Application for deleting old Log and File entries. Simply select a date and click submit. Artifacts/Logs older than this date will be removed.