diff --git a/README.md b/README.md index 98cbbe7..b39187d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# NetApp SolidFire PowerShell Tools +# SolidFire PowerShell Tools -### Version 1.5.1 +### Version 1.6 ![logo](Install/product.png) @@ -12,7 +12,19 @@ Any user with a SolidFire storage system and Windows PowerShell can take advanta ## Installation -The SolidFire Powershell Module can be installed directly on multiple systems by following these instructions: +The **preferred** way to install SolidFire PowerShell Tools is to download it from [PowerShell Gallery](powershellgallery.com) with the following command: + +### PowerShell 5 on Windows + + PS> Install-Module -Name SolidFire + +### PowerShell 6 on Windows, Mac, or Linux + + PS> Install-Module -Name SolidFire.Core + +**-- or --** + +For more detailed instructions, the SolidFire Powershell Module can be installed directly on multiple systems by following these installation guides: | System | Installation | |---------------------------|-------------------------------------------| @@ -23,6 +35,6 @@ The SolidFire Powershell Module can be installed directly on multiple systems by ## Release Notes -[Click here to download latest release notes](Install/NetApp_SolidFire_PowerShell_Tools_v1.5.1_Release_Notes.pdf) +[Click here to download latest release notes](https://github.com/solidfire/PowerShell/blob/master/Install/NetApp_SolidFire_PowerShell_Tools_v1.6_Release_Notes.pdf) -[Click here to download User Guide Doc](Install/NetApp_SolidFire_PowerShell_Tools_v1.5.1_User_Guide.pdf) +User guides are available for each system in the installation instruction pages. diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 0000000..deace7d --- /dev/null +++ b/docker/README.md @@ -0,0 +1,23 @@ +# To install SolidFire Powershell as Docker container: + +![solidfire-powershell-logo](../../Install/product.png) ![docker-logo](docker-logo-small.png) + +### Prerequisite: + +You must have Docker engine installed and running on your host machine. [Install the latest docker engine](https://www.docker.com/products/overview) + +### Run the SolidFire Powershell Container: + +Using a terminal, pull and run the latest SolidFire PowerShell image from our public Docker repo with this command: + + docker run -it -v $(pwd):/scripts netapp/solidfire-powershell + +This will download that SolidFire Docker image, start a new container, and open a PowerShell shell from your terminal with the SolidFire module loaded and ready. + +**NOTE:** Any scripts in your host's pwd* will be available at `/scripts` once you are in the PowerShell shell. + +*Present Working Directory + +**ProTip:** +You can change the mounted directory for `/scripts` by modifying the left side of the ':'. Use " " when a space exists in the path. +Ex: `docker run -it -v "/Users//Documents/Github/":/scripts netapp/solidfire-powershell` diff --git a/docker/create-posh-DEVELOP b/docker/create-posh-DEVELOP new file mode 100644 index 0000000..4f88333 --- /dev/null +++ b/docker/create-posh-DEVELOP @@ -0,0 +1,61 @@ +############################################################ +# Dockerfile to create SolidFire PowerShell Container +# From Jenkins DEVELOP branch +# Based on Ubuntu Image +############################################################ + +# Set the base image to use to Ubuntu +FROM ubuntu + +# Set the file maintainer (your name - the file's author) +MAINTAINER NetApp SolidFire Host Integrations + +# Add security to apt sources list +# RUN echo "deb http://security.ubuntu.com/ubuntu trusty-security main" >> /etc/apt/sources.list + +# Update the default application repository sources list +RUN apt-get update + +# Install sudo +RUN apt-get install sudo -y + +# Install WGET +RUN apt-get install wget -y + +# Install CURL +RUN apt-get install curl -y + +# Use a non-root account +# RUN useradd -ms /bin/bash posh +# USER posh +# WORKDIR /home/posh +# RUN whoami + +# Install Powershell dependencies +RUN sudo apt-get install libcurl3 libunwind8 libicu55 -y + +# Download Powershell for Ubuntu +RUN wget https://github.com/PowerShell/PowerShell/releases/download/v6.0.0-alpha.13/powershell_6.0.0-alpha.13-1ubuntu1.16.04.1_amd64.deb + +# Install Powershell +RUN sudo dpkg -i powershell_6.0.0-alpha.13-1ubuntu1.16.04.1_amd64.deb +RUN sudo apt-get install -f + +# Install Powershell +# RUN curl -fsSL https://raw.githubusercontent.com/PowerShell/PowerShell/v6.0.0-alpha.13/tools/download.sh | bash -s + +# Setup Module Directory +RUN mkdir -p /usr/local/share/powershell/Modules/SolidFire + +# Download the SolidFire PowerShell module files +#RUN wget -P /usr/local/share/powershell/Modules/SolidFire/ http://hi-jenkins.eng.solidfire.net:8080/view/SDK/job/solidfire-sdk-dotnet-DEVELOP/lastSuccessfulBuild/artifact/src/DotNetSdk/bin/Debug/netstandard1.6/DotNetSdk.dll + +#RUN wget -P /usr/local/share/powershell/Modules/SolidFire/ http://hi-jenkins.eng.solidfire.net:8080/view/SDK/job/solidfire-sdk-dotnet-DEVELOP/lastSuccessfulBuild/artifact/src/DotNetSdk/bin/Debug/net46/Newtonsoft.Json.dll + +#RUN wget -P /usr/local/share/powershell/Modules/SolidFire/ http://hi-jenkins.eng.solidfire.net:8080/view/PowerShell/job/PowerShell%20Build%20Develop/lastSuccessfulBuild/artifact/src/PowerShellModule/bin/Debug/netstandard1.6/SolidFire.dll + +#RUN wget -P /usr/local/share/powershell/Modules/SolidFire/ http://hi-jenkins.eng.solidfire.net:8080/view/PowerShell/job/PowerShell%20Build%20Develop/lastSuccessfulBuild/artifact/src/PowerShellModule/SolidFire.psd1 + + +# Set the entrypoint to powershell command +ENTRYPOINT powershell diff --git a/docker/docker-logo-small.png b/docker/docker-logo-small.png new file mode 100644 index 0000000..db6cf80 Binary files /dev/null and b/docker/docker-logo-small.png differ diff --git a/linux/README.md b/linux/README.md new file mode 100644 index 0000000..0141e7b --- /dev/null +++ b/linux/README.md @@ -0,0 +1,39 @@ +# Install SolidFire PowerShell on Linux + +![solidfire-powershell-logo](../../Install/product.png) ![linux-logo](linux-logo-small.png) + +## Installation Instructions + +The commands should be run in a terminal session on the machine you want to install on. You don't have to be in a specific directory to execute any of these commands. You will need sudo access. + +## First, Install PowerShell 6 + +Follow the detailed instructions on the [PowerShell for Linux installation page](https://docs.microsoft.com/en-us/powershell/scripting/setup/installing-powershell-core-on-macos?view=powershell-6). + +## Next, Install SolidFire.Core Module + +1. Once inside the PowerShell shell, install SolidFire PowerShell Tools by downloading it from the [PowerShell Gallery](powershellgallery.com) with the following command: + + PS> Install-Module -Name SolidFire.Core + +1. Then, import the SolidFire module with the following command: + + PS> Import-Module SolidFire.Core + +1. To see a list of available commands in this module, use: + + PS> Get-Command -Module SolidFire.Core + +## Paths + +* `$PSHOME` is `/opt/microsoft/powershell/[version]/` +* User profiles will be read from `~/.config/powershell/profile.ps1` +* Default profiles will be read from `$PSHOME/profile.ps1` +* User modules will be read from `~/.local/share/powershell/Modules` +* Shared modules will be read from `/usr/local/share/powershell/Modules` +* Default modules will be read from `$PSHOME/Modules` +* PSReadLine history will be recorded to `~/.local/share/powershell/PSReadLine/ConsoleHost_history.txt` + +The profiles respect PowerShell's per-host configuration, +so the default host-specific profiles exists at `Microsoft.PowerShell_profile.ps1` in the same locations. + diff --git a/linux/linux-logo-small.png b/linux/linux-logo-small.png new file mode 100644 index 0000000..bd049fc Binary files /dev/null and b/linux/linux-logo-small.png differ diff --git a/mac/README.md b/mac/README.md new file mode 100644 index 0000000..cdd5889 --- /dev/null +++ b/mac/README.md @@ -0,0 +1,41 @@ +# Install SolidFire PowerShell on Mac High Sierra + +![solidfire-powershell-logo](../../Install/product.png) ![apple-logo](apple-logo-small.png) + +## Installation Instructions + +The commands should be run in a terminal session on the machine you want to install on. You don't have to be in a specific directory to execute any of these commands. You will need sudo access. + +### First, Install PowerShell 6 + +Follow the detailed instructions on the [PowerShell 6 for Mac installation page](https://docs.microsoft.com/en-us/powershell/scripting/setup/installing-powershell-core-on-macos?view=powershell-6). + +### Next, Install SolidFire.Core Module + +1. Once inside the PowerShell shell, install SolidFire PowerShell Tools by downloading it from the [PowerShell Gallery](powershellgallery.com) with the following command: + + PS> Install-Module -Name SolidFire.Core + +1. Then, import the SolidFire module with the following command: + + PS> Import-Module SolidFire.Core + +1. To see a list of available commands, use: + + PS> Get-Command -Module SolidFire.Core + +## Paths + +* `$PSHOME` is `/opt/microsoft/powershell/[version]/` +* User profiles will be read from `~/.config/powershell/profile.ps1` +* Default profiles will be read from `$PSHOME/profile.ps1` +* User modules will be read from `~/.local/share/powershell/Modules` +* Shared modules will be read from `/usr/local/share/powershell/Modules` +* Default modules will be read from `$PSHOME/Modules` +* PSReadLine history will be recorded to `~/.local/share/powershell/PSReadLine/ConsoleHost_history.txt` + +The profiles respect PowerShell's per-host configuration, +so the default host-specific profiles exists at `Microsoft.PowerShell_profile.ps1` in the same locations. + +`$PSHOME` is `/usr/local/microsoft/powershell/[version]/`, +and the symlink is placed at `/usr/local/bin/powershell`. diff --git a/mac/apple-logo-small.png b/mac/apple-logo-small.png new file mode 100644 index 0000000..c10d023 Binary files /dev/null and b/mac/apple-logo-small.png differ diff --git a/windows/README.md b/windows/README.md new file mode 100644 index 0000000..82f4bc0 --- /dev/null +++ b/windows/README.md @@ -0,0 +1,34 @@ +# To install SolidFire Powershell on Windows: + +![solidfire-powershell-logo](../../Install/product.png) ![windows-logo](windows-logo-small.png) + +## Installation Instructions + +This page has instructions for installing the SolidFire PowerShell tools module on a Windows client. + +## Prerequisites + +| Component | Version | +|----------------------|------------------| +| PowerShell | 4.0 or later | +| SolidFire Element OS | 7 through 11.0 | +| .NET Framework | 4.5.1 or later | + +## Installation Instructions + +Download and launch the installer .msi file then follow the instructions in the install wizard. + +[SolidFire PowerShell Installer](https://github.com/solidfire/PowerShell/raw/master/Install/SolidFire_PowerShell_1_4_0_98-install.msi) + +** Additional installation details can be found in the SolidFire PowerShell [User Guide Doc](https://github.com/solidfire/PowerShell/blob/master/Install/NetApp_SolidFire_PowerShell_Tools_v1.6_User_Guide.pdf) + +## Supported Microsoft Operating Systems + +The following versions of Microsoft operating systems are supported and can run the SolidFire PowerShell tools. + +| Version | +|------------------------| +| Windows Server 2016 | +| Windows Server 2012 R2 | +| Windows 10 | + diff --git a/windows/windows-logo-small.png b/windows/windows-logo-small.png new file mode 100644 index 0000000..0036ca9 Binary files /dev/null and b/windows/windows-logo-small.png differ