Xl deployit how to#
Xl deployit code#

admin > serverService.maintenanceStart() MAINTENANCE admin > serverService.state() MAINTENANCE admin > serverService.maintenanceStop() RUNNING admin > Some examples of how we can use this module are as follows:Īdmin > serverService.help() * state * shutdown * maintenanceStop * maintenanceStart * licenseReload * info * gc admin > serverService.maintenanceStop() RUNNING admin > serverService.help() * state * shutdown * maintenanceStop * maintenanceStart * licenseReload * info * gc admin > serverService.help(“maintenanceStart”) Put server into MAINTENANCE mode (prepare for shutdown). With this file saved in our ext folder we can start the CLI and interact with the serverService object just like other XL Deploy objects in the CLI.

Xl deployit code#

The source code for this module is available on Gist. To do this we can create another module with a new ServerService class and create an instance of that class that will be available to all of our scripts. Instead of building a REST client in my scripts, I want this to be a part of my CLI. This is useful, but we are missing the serverService object from the REST API ( .api.ServerService).

help() To get to know more about a specific method of an object, type. To know more about a specific object, type. * tasks: Access to the task engine of XL Deploy. * task2: Access to the task block engine of XL Deploy. * deployment: Perform tasks related to setting up deployments * factory: Helper that can construct Configuration Items (CI) and Artifacts * repository: Gateway to doing CRUD operations on all types of CIs * security: Access to the security settings of XL Deploy. * deployit: The main gateway to interfacing with XL Deploy. When you start the CLI you can get a list of these objects by running the help() command as follows:Īdmin > help() XL Deploy Objects available on the CLI: When we start the CLI there are several objects that are loaded to allow the CLI to interact with the XL Deploy server. This is the use case that I was initially interested in. That is the first way you can extend the XL Deploy CLI.Īnother interesting way of extending the CLI is to put scripts in the ext folder. We can see how that might work as follows:Īdmin > import Pizza admin > p = Pizza.Pizza( 12, ) admin > print p.getSize() 12 admin > p.listToppings() peperoni mushrooms sausage cheese green peper onion admin > Now when we run the CLI, this module will be available to us. We will save this module file in /opt/xebialabs/xl-deploy-5.0.1-cli/lib/Lib/Pizza.py. Since I like pizza I’m going to make a little Pizza class and put it in a Pizza (Pizza.py) module as follows:ĭef _init_(self, size, toppings = ): self.size = size self.toppings = toppingsĭef setSize( self, size ): self.size = sizeĭef addToppings( self, topping ): ( topping )ĭef getToppings( self ): return self.toppingsĭef listToppings( self ): for topping in self.toppings: print topping # End foreach To check this out let’s make a custom module. This is the list of places the CLI is looking for modules. To figure out where you can put your custom modules in the CLI, start the CLI and do the following:Īdmin > import sys admin > sys.path PyList: admin > You can use this fact to create modules that can be reused to make your scripts more powerful.

The CLI tool is an implementation of Jython with extensions for XL Deploy. You will likely want to start breaking these CLI scripts up into smaller parts or modules. If you start writing CLI scripts that get complicated, they well become longer. Just like the XL Deploy server, the XL Deploy CLI has a few ways it can be extended.

Xl deployit how to#

That seemed inconvenient, so in this blog I’m going to show you how to extend the XL Deploy CLI with a new object that will provide all of the ServerService methods from the REST API in the CLI. One of our customers noticed that we did not have a CLI way to put the XL Deploy server in maintenance mode. This allows you to prevent users from making changes to the repository while the administrators are trying to work with the repository or to cleanly restart the server. In the newer versions of XL Deploy (5.x) there is a new feature that allows you to put the XL Deploy server in maintenance mode.