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.

Sign up for GitHub

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

Jump to bottom

Add documentation #20

Merged
merged 5 commits into from
Apr 6, 2017
Merged

Add documentation #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c2517dd
Add documentation
ayeleta Mar 17, 2017
3c02d7d
add an example file for get_version
ayeleta Mar 17, 2017
348341b
Add info to readme.md file
ayeleta Mar 17, 2017
e8aba55
Update README.md
kalsky Mar 29, 2017
f2292f1
Add files via upload
jimbr70 Mar 30, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added Documentation/cloudshell-orch-sandbox deployment guide.docx
View file
Open in desktop
Binary file not shown.
24 changes: 24 additions & 0 deletions Documentation/get_version_example.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# This file demonstrates implementation of get_version for Ericsson's IPOS/SEOS devices.

from cloudshell.helpers.scripts import cloudshell_scripts_helpers as helpers
from cloudshell.api.cloudshell_api import *
import re


def main():
api_session = helpers.get_api_session()
resource_details = helpers.get_resource_context_details()
reservation_id = helpers.get_reservation_context_details().id
# Run custom command on the device requesting the version
command_inputs = [InputNameValue('custom_command', str('show version'))]
cmd_out = api_session.ExecuteCommand(reservation_id, resource_details.name, 'Resource', 'run_custom_command',
commandInputs=command_inputs).Output
# Clean unwanted text, leaving only the version itself
match = re.search('(Ericsson IPOS Version|SmartEdge OS Version).+',cmd_out)
version=match.group(0)
version = version.replace('Ericsson IPOS Version ','')
version = version.replace('SmartEdge OS Version ','')
print str(version)


main()
69 changes: 69 additions & 0 deletions Documentation/gitlabrepo-import.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<ResourceManagementExportImport xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.qualisystems.com/ResourceManagement/ExportImportConfigurationSchema.xsd">
<Tags>
<Tag Name="Editable After Run (System Administrators)" />
<Tag Name="Editable After Run (Everyone)" />
<Tag Name="Configuration" />
<Tag Name="Setting" />
<Tag Name="Displayed In Diagram" />
<Tag Name="Link Configurations" />
<Tag Name="Variable Capability" />
<Tag Name="Constant Capability" />
<Tag Name="Topology Category" />
<Tag Name="Displayed In Route Creation" />
<Tag Name="Available For Abstract Resources" />
<Tag Name="Displayed In Search Filters" />
<Tag Name="Execution Server Selector" />
<Tag Name="Monitor Modifications" />
<Tag Name="Admin Only" />
<Tag Name="Displayed In Insight" />
</Tags>
<Attributes>
<AttributeInfo Name="GitLab URL" Type="String" DefaultValue="" IsReadOnly="false" IsCommand="false">
<Tags>
<TagName Name="Configuration" />
</Tags>
</AttributeInfo>
<AttributeInfo Name="GitLab Token" Type="String" DefaultValue="" IsReadOnly="false" IsCommand="false">
<Tags>
<TagName Name="Configuration" />
</Tags>
</AttributeInfo>
<AttributeInfo Name="GitLab Project Name" Type="String" DefaultValue="" IsReadOnly="false" IsCommand="false">
<Tags>
<TagName Name="Configuration" />
</Tags>
</AttributeInfo>
</Attributes>
<Modules>
</Modules>
<ResourceFamilies>
<ResourceFamily Name="Repository" IsMappableContainer="false" IsMappable="false" IsConnectable="false" IsLicenseCheckRequired="false" IsAllConnectedContainer="false" IsLockedByDefault="false" AcceptsMultipleConnections="false" Description="" SupportsMulticastMapping="false" SupportsLoopbackMapping="false" IsPowerSwitch="false" IsConsoleServer="false" ResourceType="Resource" IsAdminOnly="true" Searchable="true">
<AttachedAttributes />
<AttributeValues />
<Models>
<ResourceModel Name="GitLab" Description="" SupportsConcurrentCommands="false">
<AttachedAttributes>
<AttachedAttribute Name="GitLab URL" IsOverridable="true" IsLocal="true">
<AllowedValues />
</AttachedAttribute>
<AttachedAttribute Name="GitLab Token" IsOverridable="true" IsLocal="true">
<AllowedValues />
</AttachedAttribute>
<AttachedAttribute Name="GitLab Project Name" IsOverridable="true" IsLocal="true">
<AllowedValues />
</AttachedAttribute>
</AttachedAttributes>
<AttributeValues>
<AttributeValue Name="GitLab URL" Value="" />
<AttributeValue Name="GitLab Token" Value="" />
<AttributeValue Name="GitLab Project Name" Value="" />
</AttributeValues>
<ParentModels />
<Drivers />
</ResourceModel>
</Models>
</ResourceFamily>
</ResourceFamilies>
<DriverDescriptors>
</DriverDescriptors>
</ResourceManagementExportImport>
105 changes: 105 additions & 0 deletions Documentation/orch-sandboxDataModel.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@

<ResourceManagementExportImport xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.qualisystems.com/ResourceManagement/ExportImportConfigurationSchema.xsd">
<Tags>
<Tag Name="Editable After Run (System Administrators)" />
<Tag Name="Editable After Run (Everyone)" />
<Tag Name="Configuration" />
<Tag Name="Setting" />
<Tag Name="Displayed In Diagram" />
<Tag Name="Link Configurations" />
<Tag Name="Variable Capability" />
<Tag Name="Constant Capability" />
<Tag Name="Topology Category" />
<Tag Name="Displayed In Route Creation" />
<Tag Name="Available For Abstract Resources" />
<Tag Name="Displayed In Search Filters" />
<Tag Name="Execution Server Selector" />
<Tag Name="Monitor Modifications" />
<Tag Name="Admin Only" />
<Tag Name="Displayed In Insight" />
</Tags>
<Attributes>
<AttributeInfo Name="Storage Port" Type="Numeric" DefaultValue="0" IsReadOnly="false" IsCommand="false">
<Tags>
<TagName Name="Configuration" />
<TagName Name="Setting" />
</Tags>
</AttributeInfo>
<AttributeInfo Name="Storage Network configs Path" Type="String" DefaultValue="" IsReadOnly="false" IsCommand="false">
<Tags>
<TagName Name="Configuration" />
<TagName Name="Setting" />
</Tags>
</AttributeInfo>
<AttributeInfo Name="Storage username" Type="String" DefaultValue="" IsReadOnly="false" IsCommand="false">
<Tags>
<TagName Name="Configuration" />
</Tags>
</AttributeInfo>
<AttributeInfo Name="Storage password" Type="String" DefaultValue="" IsReadOnly="false" IsCommand="false">
<Tags>
<TagName Name="Configuration" />
</Tags>
</AttributeInfo>
<AttributeInfo Name="Orch Config file path" Type="String" DefaultValue="" IsReadOnly="false" IsCommand="false">
<Tags>
<TagName Name="Configuration" />
</Tags>
</AttributeInfo>
<AttributeInfo Name="Orch Disable Load Config" Type="Boolean" DefaultValue="False" IsReadOnly="false" IsCommand="false">
<Tags>
<TagName Name="Configuration" />
</Tags>
</AttributeInfo>
</Attributes>
<Modules>
</Modules>
<ResourceFamilies>
<ResourceFamily Name="Storage server" IsMappableContainer="false" IsMappable="false" IsConnectable="false" IsLicenseCheckRequired="false" IsAllConnectedContainer="false" IsLockedByDefault="false" AcceptsMultipleConnections="false" Description="" SupportsMulticastMapping="false" SupportsLoopbackMapping="false" IsPowerSwitch="false" IsConsoleServer="false" ResourceType="Resource" IsAdminOnly="true" Searchable="true">
<AttachedAttributes />
<AttributeValues />
<Models>
<ResourceModel Name="Generic FTP server" Description="" SupportsConcurrentCommands="false">
<AttachedAttributes>
<AttachedAttribute Name="Storage Port" IsOverridable="true" IsLocal="true">
<AllowedValues />
</AttachedAttribute>
<AttachedAttribute Name="Storage Network configs Path" IsOverridable="true" IsLocal="true">
<AllowedValues />
</AttachedAttribute>
<AttachedAttribute Name="Storage username" IsOverridable="true" IsLocal="true">
<AllowedValues />
</AttachedAttribute>
<AttachedAttribute Name="Storage password" IsOverridable="true" IsLocal="true">
<AllowedValues />
</AttachedAttribute>
</AttachedAttributes>
<AttributeValues>
<AttributeValue Name="Storage Network configs Path" Value="" />
<AttributeValue Name="Storage username" Value="" />
<AttributeValue Name="Storage password" Value="" />
<AttributeValue Name="Storage Port" Value="21" />
</AttributeValues>
<ParentModels />
<Drivers />
</ResourceModel>
</Models>
</ResourceFamily>
<ResourceFamily Name="Pool" IsMappableContainer="false" IsMappable="false" IsConnectable="false" IsLicenseCheckRequired="false" IsAllConnectedContainer="false" IsLockedByDefault="true" AcceptsMultipleConnections="false" Description="" SupportsMulticastMapping="false" SupportsLoopbackMapping="false" IsPowerSwitch="false" IsConsoleServer="false" ResourceType="Resource" IsAdminOnly="true" Searchable="true">
<AttachedAttributes />
<AttributeValues />
<Models>
<ResourceModel Name="Config Set Pool" Description="" SupportsConcurrentCommands="false">
<ParentModels />
<Drivers />
<AttachedAttributes />
<AttributeValues />
<ParentModels />
<Drivers />
</ResourceModel>
</Models>
</ResourceFamily>
</ResourceFamilies>
<DriverDescriptors>
</DriverDescriptors>
</ResourceManagementExportImport>
33 changes: 33 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,37 @@

Package for sandbox orchestration script functions

## Overview
The orchestration package should bring an out-of-the-box solution for our customer’s common use cases:
- Setting up the sandbox upon reservation
- Tearing down a sandbox
- Save a snapshot of a sandbox

### Setup
During the setup process the script will iterate over the resources and prepare them for the reservation.
- For each networking device:
- Perform health check (if exists)
- Load firmware (optional)
- Load configuration (optional)
- Re-run health check (if exists)
- VMs (when represented by Apps Deployment)
- Deploy apps
- Power on VM
- Activate all routes and connectors

### Teardown
During the teardown process the script will wipe the configuration from the networking devices and delete VMs bringing them back into “ready for use” state.
- For each networking device:
- Perform health check (if exists)
- Load firmware (optional)
- Load configuration (optiona)
- Re-run health check (if exists)
- VMs
- Delete/Power off VM
- Disconnect routes and connectors

### Snapshot
The user can save a snapshot of the sandbox. In the background, the script will save the sandbox as a new blueprint, and the current configuration of the devices and VMs will be saved for future use (reserving this saved blueprint will restore the configuration on the resources and the VM snapshots).
- Save the sandbox as a blueprint
- Save all the configuration files of the devices on the storage server (e.g. FTP server)