Skip to content

Commit b6b8b31

Browse files
committed
Added TentacleMachineNameSuffix to the readme
1 parent a0b8443 commit b6b8b31

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ It's really easy to get up and running - more details below, but in short:
1010

1111
1. Configure a standard Web Role project in Visual Studio
1212
2. `Install-Package AzureWebFarm.OctopusDeploy`
13-
3. Configure 4 cloud service variables - `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment` and `TentacleRole`
13+
3. Configure 5 cloud service variableos - `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment`, `TentacleRole` and `TentacleMachineNameSuffix`
1414
4. Deploy to Azure and watch the magic happen!
1515

1616
tl;dr
@@ -38,7 +38,7 @@ Pre-requisites
3838
* `OctopusApiKey` - [API key of a user](https://github.com/OctopusDeploy/OctopusDeploy-Api/wiki/Authentication) that has at least the following privileges in the environment you are deploying to: ("Environment manager" and "Project deployer") or ("System administrator")
3939
* `TentacleEnvironment` - Name of the environment that you want to deploy to
4040
* `TentacleRole` - Name of the role you want your web farm servers to have
41-
* `TentacleMachineNameSuffix` - The suffix to append to the machine name when adding the tentacle to octopus, allows for a single package to be reused with different config for multiple roles.
41+
* `TentacleMachineNameSuffix` - The suffix to append to the machine name when adding the tentacle to octopus, allows for a single package to be reused with different config for multiple farms against the same OctopusDeploy server.
4242
* Ensure that you open port 10943 on the Octopus Server so that Polling Tentacles can work, for more information view the documentation (http://docs.octopusdeploy.com/display/OD/Polling+Tentacles).
4343
* Ensure that if you are using HTTPS (and you should be) for your OctopusDeploy server that the HTTPS certificate is [valid or you include code to trust the invalid certificate](https://github.com/OctopusDeploy/Issues/issues/742)
4444
* You will need to [set up the website and app pool creation for your OctopusDeploy project](http://docs.octopusdeploy.com/display/OD/IIS+Websites+and+Application+Pools) (including the hostname for your site in the binding(s)) when using this library (since IIS starts off as a blank slate).
@@ -93,15 +93,15 @@ The installation instructions form two parts - normal web role installation and
9393
* When prompted that a file has been modified click **"Reload"**
9494
* If prompted that a file already exists ie `WebRole.cs`, you should allow NuGet to override it with the file from our package
9595
2. (optional) [Debug locally](#local-debugging)
96-
3. Ensure that the `ServiceConfiguration.Cloud.cscfg` file has correct values for the `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment` and `TentacleRole` variables
96+
3. Ensure that the `ServiceConfiguration.Cloud.cscfg` file has correct values for the `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment`, `TentacleRole` and `TentacleMachineNameSuffix` variables
9797
4. Deploy to Azure as per step 9 above
9898

9999
Local debugging
100100
---------------
101101
It is a good idea to debug the farm locally to make sure your configuration is correct and your OctopusDeploy server is configured correctly:
102102

103103
1. Ensure that there is only one instance locally by checking the `ServiceConfiguration.Local.cscfg` file has `<Instances count="1" />`
104-
2. Ensure that the `ServiceConfiguration.Local.cscfg` file has correct values for the `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment` and `TentacleRole` variables
104+
2. Ensure that the `ServiceConfiguration.Local.cscfg` file has correct values for the `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment`, `TentacleRole` and `TentacleMachineNameSuffix` variables
105105
3. Set the cloud project as the default project
106106
4. (optional) If you have already downloaded the tentacle installer and don't want to wait for the emulator to download it as part of startup then place the file at `c:\Octopus.Tentacle.msi` and it will automatically be used
107107
5. Hit F5 to start the Azure emulator
@@ -140,8 +140,8 @@ Apart from adding the dependencies of the package and the dll the following acti
140140
* Elevated privileges for the RoleEntryPoint code
141141
* Startup\startup.cmd as an elevated privileges startup task that has selected environment variables
142142
* A 1GB `Install` local resource directory (where the tentacle is installed) and a 19GB `Deployments` local resource directory (where deployments are stored) - if you aren't using ExtraSmall instances then you can increase the 19GB to a larger value
143-
* Four configuration settings variables are added: `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment` and `TentacleRole`
144-
* All `ServiceConfiguration.*.cscfg` files are changed to add the four configuration settings variables: `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment` and `TentacleRole`
143+
* Five configuration settings variables are added: `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment`, `TentacleRole` and `TentacleMachineNameSuffix`
144+
* All `ServiceConfiguration.*.cscfg` files are changed to add the five configuration settings variables: `OctopusServer`, `OctopusApiKey`, `TentacleEnvironment`, `TentacleRole` and `TentacleMachineNameSuffix`
145145

146146
To see how we perform all of this "magic" checkout the [install.ps1](https://github.com/MRCollective/AzureWebFarm.OctopusDeploy/blob/master/AzureWebFarm.OctopusDeploy/Tools/install.ps1) file.
147147

0 commit comments

Comments
 (0)