Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

octopus-deploy (27) Versions 0.6.1

Handles installing Octopus Deploy Server &| Tentacle

Berkshelf/Librarian
Policyfile
Knife
cookbook 'octopus-deploy', '= 0.6.1'
cookbook 'octopus-deploy', '= 0.6.1', :supermarket
knife cookbook site install octopus-deploy
knife cookbook site download octopus-deploy
README
Dependencies
Changelog
Quality 50%

Octopus Deploy Cookbook

Cookbook Converge Build Status Code Climate Chef cookbook GitHub license

This cookbook is used for installing the Octopus Deploy server and tentacle on Microsoft Windows machines.

NOTICE: Pre-Release

This is pre release and there will be major changes to this before its final release. The recipes for installation and configuration will be switched into resources so people can use the library easier. Once this is found stable it will be released as version 1.0.0, until this point lock down to any minor version that you use.

Resource/Provider

octopus_deploy_server

Actions

  • :install: Install a version of Octopus Deploy server
  • :configure: Install a version of Octopus Deploy server and configure it
  • :remove: Uninstall a version of the Octopus Deploy Server if it is installed

Attribute Parameters

  • :instance: Name attribute. The Octopus Deploy Server instance name (used for configuring the instance not install)
  • :version: Required. The version of Octopus Deploy Server to install
  • :checksum: The SHA256 checksum of the Octopus Deploy Server msi file to verify download
  • :home_path: The Octopus Deploy Server home directory (Defaults to C:\Octopus)
  • :config_path: The Octopus Deploy Server config file path (Defaults to C:\Octopus\OctopusServer.config)
  • :connection_string: The Octopus Deploy Server connection string to the MSSQL Server instance
  • :master_key: The Octopus Deploy Server master key for encryption, leave blank to generate one at creation
  • :node_name: The Octopus Deploy Server Node Name, will default to machine hostname
  • :create_database: Whether Octopus Deploy Server should create the database with the connection string provided (Defaults to false)
  • :admin_user: A default admin in AD for the Octopus Deploy Server to create
  • :license: The raw license key for Octopus Deploy Server to use
  • :start_service: Whether to start the Octopus Deploy Server service after creation of the instance (Defaults to True)

Example

Install version 3.1.1 of Octopus Deploy Server

octopus_deploy_server 'OctopusServer' do
  action :install
  version '3.1.1'
  checksum '<SHA256-checksum>'
end

octopus_deploy_tentacle

Actions

  • :install: Install a version of Octopus Deploy Tentacle (Default)
  • :configure: Configure an instance of the octopus Deploy tentacle
  • :register: Register Tentacle with Octopus Deploy Server
  • :remove: Remove an instance of the Octopus Deploy Tentacle
  • :uninstall: Uninstall a version of the Octopus Deploy Tentacle if it is installed

Attribute Parameters

  • :instance: Name attribute. The Octopus Deploy Tentacle instance name (used for configuring the instance not install)
  • :version: Required. The version of Octopus Deploy Tentacle to install
  • :checksum: The SHA256 checksum of the Octopus Deploy Tentacle msi file to verify download
  • :home_path: The Octopus Deploy Instance home directory (Defaults to C:\Octopus)
  • :config_path: The Octopus Deploy Instance config file path (Defaults to C:\Octopus\Tentacle.config)
  • :app_path: The Octopus Deploy Instance application directory (Defaults to C:\Octopus\Applications)
  • :trusted_cert: The Octopus Deploy Instance trusted Server cert
  • :port: The Octopus Deploy Instance port to listen on for listening tentacle (Defaults to 10933)
  • :configure_firewall: Whether cookbook will open firewall on listen tentacles (Defaults to false)
  • :polling: Whether this Octopus Deploy Instance is a polling tentacle (Defaults to False)
  • :cert_file: Where to export the Octopus Deploy Instance cert (Defaults to C:\Octopus\tentacle_cert.txt)
  • :upgrades_enabled: Whether to upgrade or downgrade the tentacle version if the windows installer version does not match what is provided in the resource. (Defaults to True)
  • :server: Url to Octopus Deploy Server (e.g https://octopus.example.com)
  • :api_key: Api Key used to register Tentacle to Octopus Server
  • :roles: Array of roles to apply to Tentacle when registering with Octopus Deploy Server (e.g ["web-server","app-server"])
  • :environment: Which environment the Tentacle will become part of when registering with Octopus Deploy Server (Defaults to node.chef_environment )

Examples

Install version 3.2.24 of Octopus Deploy Tentacle

This will simply install the version of the tentacle that is specified.

octopus_deploy_tentacle 'Tentacle' do
  action :install
  version '3.2.24'
  checksum '147f84241c912da1c8fceaa6bda6c9baf980a77e55e61537880238feb3b7000a'
end
Install version 3.2.24 of Octopus Deploy Tentacle and configure it

This will install the tentacle and then configure the tentacle on the machine to communicate with the Octopus Deploy server. It can also update firewall rules if enabled.

octopus_deploy_tentacle 'Tentacle' do
  action [:install, :configure]
  version '3.2.24'
  checksum '147f84241c912da1c8fceaa6bda6c9baf980a77e55e61537880238feb3b7000a'
  trusted_cert 'b5b7ea6537852fb5b7ea6537852f3428'
  # You can enable this resource to update firewall rules as well
  configure_firewall true
end
Register Listening Tentacle with the Octopus Deploy Server

This will check if the tentacle is registered on the Octopus Deploy server and if it is not will register the tentacle in the environment with the tags that are specified.

# You will first need to generate an api key
# In Octopus Deploy Server GUI click your Name -> Profile -> API keys
octopus_deploy_tentacle 'Tentacle' do
  action :register
  server 'https://octopus.example.com'
  api_key '12345678910'
  roles ['database']
  # You can set polling to true for a polling tentacle setup
  # polling true
end

Assumptions

One major assumption of this cookbook is that you already have .net40 installed on your server. If you do not then you might need to do that before this cookbook. In addition, some of the resources in here require Chef version 12 in order to work.

Known Issues

This does not work with Octopus Deploy versions less than 3.2.3 because of a bug in exporting tentacle certificates

Tentacle roles are only used the first time a Tentacle is registered with an Octopus Deploy Server. Updating tentacle roles in cookbook will not update roles on Octopus Deploy Server.

Registering multiple tentacles on the same machine is not supported.

Switching Tentacle modes between 'polling' & 'listening' is not currently supported.

License and Author

Copyright:: 2015, Cvent, Inc.

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.

Please refer to the license file for more license information.

Dependent cookbooks

windows_firewall ~> 3.0.2
windows ~> 1.38

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Change Log

v0.6.1 (2016-08-15)

Full Changelog

Merged pull requests:

  • Add unit test to validate library assumptions #49 (brentm5)
  • Refactor registering tentacle resource #47 (brentm5)

v0.6.0 (2016-08-08)

Full Changelog

Merged pull requests:

  • Set tentacle register environment default to be the chef environment #45 (spuder)
  • Add ability for the tentacle resource to setup firewall rule for listening tentacles #43 (spuder)
  • Add changelog generator and first changelog file #39 (brentm5)
  • Add ability to register tentacle with server through tentacle resource #33 (spuder)
  • Include optional master key attribute for configuring a server instance #25 (brentm5)

v0.5.1 (2016-04-04)

Full Changelog

Merged pull requests:

  • Fix issue with notifying service to restart when its disabled! #22 (brentm5)

v0.5.0 (2016-04-01)

Full Changelog

v0.4.8 (2016-03-09)

Full Changelog

Merged pull requests:

  • Remove lazy loaded values to fix chef-clients < 12.5 #18 (brentm5)

v0.4.7 (2016-03-09)

Full Changelog

Merged pull requests:

  • Cleanup tentacle resources and change remove functionality #14 (brentm5)

v0.4.6 (2016-03-01)

Full Changelog

Merged pull requests:

  • Add configure action to Octopus Deploy server resource #19 (brentm5)
  • Update windows version to be a little less strict and fix uninstall action #13 (brentm5)
  • Allow an option so chef does not downgrade tentacle versions #12 (brentm5)
  • Update tentacle resource and bump patch version #9 (brentm5)
  • Add appveyor for builds so that we can test converges #8 (brentm5)
  • Generate a machine level certificate file that could be used later #7 (brentm5)
  • Generate a machine level certificate file that could be used later #6 (brentm5)
  • Make sure that the services is restarted if we configure or reconfigure the tentacle #5 (brentm5)
  • Setup configure action on tentacle :boom: :metal: #4 (brentm5)
  • Upgrade the octopus deploy cookbook to use custom resources #2 (brentm5)
  • Add travis and fix some issues with code that tests uncovered #1 (brentm5)

* This Change Log was automatically generated by github_changelog_generator

Collaborator Number Metric
            

0.6.1 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Foodcritic Metric
            

0.6.1 passed this metric