smi-service-dell-server-os-deployment

A Java Spring Boot Microservice that exposes a REST API. Used to perform operating system deployment on Dell servers using the IDRAC's ability to mount and expose an ISO.

This service is intended to support the deployment of various Operating System types. Currently only ESXI 6.x is supported.

Purpose

The service-os-deployment container is a stateless spring-boot microservice that exposes a REST API's to:

Read files from a source ISO and create a new, repackaged ISO that specifies the location of a Kickstart file to use
deploy an ISO image stored on a network share to to a Dell server
detach virtual media on a Dell server

How to use

Startup

On the host system that runs docker, create a directory and mount a remote NFS or CIFS share. Example:

sudo mkdir /mnt/filesFromFs01
sudo mount 100.100.100.100:/opt/dell/public /mnt/filesFromFs01

Use docker run with the -v option to use the mount above inside of the container. Example:

sudo docker run --name osdeployment -p 0.0.0.0:46014:46014 -v /mnt/filesFromFs01:/public -d rackhd/dell-os-deployment:latest

API Definitions

A swagger UI is provided by the microservice at:

http://<<ip>>:46014/swagger-ui.html

Example API Endpoints

Create ISO

Endpoint: POST /api/1.0/server/osdeployment/iso/create

{
	"kickStartFileName" :"myCustomKickstart.cfg",
	"ksLocation" : "nfs://100.100.100.100/opt/dell/public/",
	"sourceDir": "/public",
	"fileName": "VMware-VMvisor-Installer-6.0.0.update03-5572656.x86_64-DellEMC_Customized-A04.iso",
	"destinationDir": "/public",
	"shareAddress": "100.100.100.100",
	"destinationFileName": "myCustomIso.iso"
}

Deploy ISO

Endpoint: POST /api/1.0/server/osdeployment/deploy

{
	"serverAddress": "100.68.124.121",
	"userName": "root", 
	"password": "calvin",
	"hypervisorType": "ESXi6",
	"hypervisorVersion": "6.5",
	"isoFileShare": 
	{
	    "address": "100.100.100.100",
	    "description": "nfs",
	    "fileName": "myCustomIso.iso",
	    "path": "/public",
	    "scriptDirectory": "NA",
	    "scriptName": "NA",
	    "type": "NFS",
	    "name": "Name-NFS
	}
}

Unmount ISO

Endpoint: POST /api/1.0/server/osdeployment/iso/detach

{
	"address": "100.68.124.121",
	"userName": "root", 
	"password": "calvin"
}

Licensing

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Source code for this microservice is available in repositories at https://github.com/RackHD.

The microservice makes use of dependent Jar libraries that may be covered by other licenses. In order to comply with the requirements of applicable licenses, the source for dependent libraries used by this microservice is available for download at: https://bintray.com/rackhd/binary/download_file?file_path=smi-service-dell-server-os-deployment-dependency-sources-devel.zip

The following dependent jar libraries are licensed under the LGPL license (https://www.gnu.org/copyleft/lesser.txt): loopy-core-1.2.2.jar loopy-vfs-1.2.2.jar

The following dependent jar libraries are licensed under the LGPL 2.1 license (http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html): jcifs-1.3.18-kohsuke-1.jar logback-classic-1.1.9.jar logback-core-1.1.9.jar hk2-api-2.5.0-b32.jar hk2-locator-2.5.0-b32.jar hk2-utils-2.5.0-b32.jar

The following dependent jar libraries are licensed under the CDDL 1.1 and GPL 2.0 license (https://spdx.org/licenses/CDDL-1.1.html) : javax.ws.rs-api-2.0.1.jar jersey-apache-client4-1.19.1.jar jersey-client-1.19.1.jar jersey-client-2.25.1.jar jersey-common-2.25.1.jar jersey-core-1.19.1.jar jersey-entity-filtering-2.25.1.jar jersey-guava-2.25.1.jar jersey-media-json-jackson-2.25.1.jar

The following dependent jar library is licensed under the CDDL license (https://opensource.org/licenses/cddl1.php): jsr311-api-1.1.1.jar

The following dependent jar library is licensed under the EPL 1.0 license (http://www.eclipse.org/legal/epl-v10.html): aspectjweaver-1.8.9.jar

This product may be distributed with open source code, licensed to you in accordance with the applicable open source license. If you would like a copy of any such source code, Dell EMC will provide a copy of the source code that is required to be made available in accordance with the applicable open source license. Dell EMC may charge reasonable shipping and handling charges for such distribution. Please direct requests in writing to Dell EMC Legal, 176 South St., Hopkinton, MA 01748, ATTN: Open Source Program Office.

Additionally the binary and source jars for all dependent libraries are available for download on Maven Central.

RackHD is a Trademark of Dell EMC

rackhd / smi-service-dell-server-os-deployment Goto Github PK