alexnabokikh / windows-playbook Goto Github PK

View Code? Open in Web Editor NEW

212.0 3.0 54.0 176 KB

Windows setup and configuration via Ansible.

License: MIT License

PowerShell 100.00%

windows chocolatey ansible playbook automation windows-10 windows-11

windows-playbook's Introduction

Windows Ansible Playbook

This playbook installs and configures most of the software I use on my Windows 11 machine for software development.

Playbook capabilities
Installation
Windows host prerequisites installation
Ansible control node prerequisites installation
Running a specific set of tagged tasks
Overriding Defaults
Included Applications / Configuration (Default)
Available Parameters

Playbook capabilities

NOTE: The Playbook is fully configurable. You can skip or reconfigure any task by Overriding Defaults.

Software
- Remove Bloatware (see default config for a complete list of Bloatware).
- Install software and packages selected by the user via Chocolatey.
- Install software and packages selected by the user via WinGet.
Windows apps & features
- Install and Enable Optional Windows Features chosen by the user.
- Install and Enable the WSL2 distro selected by the user.
- Run defragmentation on volumes selected by the user (in parallel).
Windows Settings
- Explorer
  - Enable Explorer file extensions in file names.
  - Open Explorer in the Computer view by default.
  - Disable the Ribbon menu in Windows Explorer.
  - Enable Right-click Context Menu (Windows 11).
- Start Menu
  - Disable Automatic Install of Suggested Apps.
  - Disable the "App Suggestions" in the Start menu.
  - Disable the "tips" popup.
  - Disable 'Windows Welcome Experience'.
- Taskbar
  - Unpin 'Search' from Taskbar.
  - Unpin Task View, Chat, and Cortana from Taskbar.
  - Unpin 'News and Interests' from Taskbar.
  - Unpin 'People' from Taskbar.
  - Unpin 'Edge', 'Store' and other built-in shortcuts from the Taskbar.
- Desktop
  - Remove Desktop icons (Ink).
- General
  - Set the hostname selected by the user is assigned.
  - Configure remote desktop services.
  - Set the sound scheme to 'No sounds'.
  - Set the power plan selected by the user.
  - Install Windows updates categories selected by the user.
  - Disable mouse acceleration.
Terminal Settings
- Install oh-my-posh with the theme chosen by the user and it set as a default PowerShell theme engine.

Installation

Prepare your Windows host ⏲

This playbook was tested on Windows 10 2004 and Windows 11 21H2 (Pro, Ent). Other versions may work but have not tried.

Copy and paste the code below into your PowerShell terminal to get your Windows machine ready to work with Ansible.

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
$url = "https://raw.githubusercontent.com/AlexNabokikh/windows-playbook/master/setup.ps1"
$file = "$env:temp\setup.ps1"

(New-Object -TypeName System.Net.WebClient).DownloadFile($url, $file)
powershell.exe -ExecutionPolicy ByPass -File $file -Verbose

Ansible Control node 🕹

Install Ansible:
1. Upgrade Pip: pip3 install --upgrade pip
2. Install Ansible: pip3 install ansible
Clone or download this repository to your local drive.
Run ansible-galaxy install -r requirements.yml inside this directory to install required Ansible collections.
Add the IP address and credentials of your Windows machine into the inventory file
Run ansible-playbook main.yml inside this directory.

Running a specific set of tagged tasks

You can filter which part of the provisioning process to run by specifying a set of tags using ansible-playbook --tags flag. The tags available are choco , debloat , desktop , explorer , fonts , hostname , mouse , power , sounds , start_menu , taskbar , updates , windows_features , wsl, winget.

ansible-playbook main.yml --tags "choco,wsl"

Overriding Defaults

NOTE: You can override any of the defaults configured in default.config.yml by creating a config.yml file and setting the overrides in that file. For example, you can customize the installed packages and enable/disable specific tasks with something like:

configure_hostname: true
custom_hostname: myhostname

install_windows_updates: true
update_categories:
  - Critical Updates
  - Security Updates
  - * # Installs all updates

choco_installed_packages:
  # installs latest version of the Google Chrome while ignoring the package checksum
  - name: googlechrome
    state: latest
    choco_args: --ignorechecksum
  # installs 2.37.1 version of the git
  - name: git
    version: "2.37.1"
  # installs GO, but won't update it
  - golang

install_fonts: true
installed_nerdfonts:
  - Meslo

install_ohmyposh: true
ohmyposh_theme: agnoster

install_windows_features: true
windows_features:
  Microsoft-Hyper-V: true

install_wsl2: true
wsl2_distribution: wsl-archlinux

remove_bloatware: true
bloatware:
  - Microsoft.Messaging

Included Applications / Configuration (Default)

Packages (installed with Chocolatey):

adobereader
auto-dark-mode
awscli
Firefox
git
golang
jre8
kubernetes-cli
microsoft-windows-terminal
peazip
powertoys
python3
sharex
telegram
terraform
vlc
vscode
zoom

Available Parameters

Name	Description	Type	Default
configure_hostname	(Optional) Whether or not to set a custom hostname.	`bool`	`false`
custom_hostname	(Optional) The hostname to set for the computer.	`string`	`windows-ansible`
install_windows_updates	(Optional) Whether or not to install Windows updates.	`bool`	`true`
update_categories	(Optional) A list of categories to install updates from. The value * will match all categories.	`list`	`["CriticalUpdates", "SecurityUpdates", "UpdateRollups"]`
windows_updates_reboot	(Optional) Whether or not to reboot the host if it is required and continue to install updates after the reboot.	`bool`	`true`
remove_bloatware	(Optional) Whether or not to uninstall Windows bloatware.	`bool`	`true`
bloatware	(Optional) A list of applications (bloatware) to be uninstalled	`list`	full_list
choco_installed_packages	(Optional) A list of Chocolatey packages to be installed.	`dict`	full_list
choco_installed_packages.state	(Optional) State of the package on the system. (present, latest)	`string`	`present`
choco_installed_packages.version	(Optional) Specific version of the package to be installed.	`string`	`omit`
choco_installed_packages.choco_args	(Optional) Additional parameters to pass to choco.exe.	`string`	`omit`
install_windows_features	(Optional) Whether or not to install Windows features.	`bool`	`false`
windows_features	(Optional) A list of dicts with Windows features to be installed.	`list(dict)`	`Microsoft-Hyper-V: true`
install_wsl2	(Optional) Whether or not to install Windows Subsystem for Linux.	`bool`	`true`
wsl2_distribution	(Optional) The valid name of Linux distribution that will be installed.	`string`	`wsl-ubuntu-2004`
install_fonts	(Optional) Whether or not to install Nerd Fonts.	`bool`	`true`
installed_nerdfonts	(Optional) A list of Nerd Fonts to be installed.	`list`	`["FiraCode", "FantasqueSansMono"]`
install_ohmyposh	(Optional) Whether or not to Oh My Posh.	`bool`	`true`
configure_explorer	(Optional) Whether or not to configure Windows Explorer with sane defaults.	`bool`	`true`
configure_taskbar	(Optional) Whether or not to configure Windows TaskBar with sane defaults.	`bool`	`true`
configure_start_menu	(Optional) Whether or not to configure Windows Start menu with sane defaults.	`bool`	`true`
set_sound_scheme	(Optional) Whether or not to set default Windows Sound Scheme to "No Sounds".	`bool`	`true`
disable_mouse_acceleration	(Optional) Whether or not to disable mouse acceleration.	`bool`	`true`
remote_desktop_enabled	(Optional) Whether or not enable Remote Desktop.	`bool`	`true`
remove_desktop_icons	(Optional) Whether or not remove desktop icons (*.lnk files only).	`bool`	`false`
defrag_volumes	(Optional) Whether or not to perform disk defragmentation.	`bool`	`true`
include_volumes	(Optional) A list of volumes to be defragmented.	`list`	`["C"]`
change_power_plan	(Optional) Whether or not change Power Plan.	`bool`	`true`
power_plan	(Optional) Choose a power plan (high_performance, balanced, power_saver).	`string`	`high_performance`
install_winget_packages	(Optional) Whether or not to install WinGet packages.	`bool`	`true`
winget_packages	(Required) A list of WinGet packages to be installed.	`dict`
winget_packages.name	(Optional) A name of the WinGet package to be installed.	`string`
winget_packages.source	(Optional) The source of the WinGet package (`msstore` or `winget`).	`string`
configure_storage_sense	(Optional) Whether or not configure Windows Storage Sense.	`string`
storage_sense	(Optional) A map of storage_sense options.	`dict`
storage_sense.enabled	(Optional) Enable or Disable Windows Storage Sense.	`bool`	`true`
storage_sense.run_frequency	(Optional) How often Windows Storage Sense has to run (once in 1, 7 or 30 days).	`int`	`1`
storage_sense.delete_unused_files	(Optional) Delete temporary files that my apps aren’t using.	`bool`	`true`
storage_sense.delete_recycle_bin_files	(Optional) Delete files in my recycle bin.	`bool`	`true`
storage_sense.recycle_bin_age	(Optional) How often recycle bin has to be cleaned up (once in 1, 14, 30 or 60 days).	`int`	`14`
storage_sense.delete_downloads_files	(Optional) Delete files in my Downloads folder.	`bool`	`true`
storage_sense.downloads_age	(Optional) How often downloaded files has to be cleaned up (once in 1, 14, 30 or 60 days).	`int`	`14`

Author

This project was created by Alexander Nabokikh (initially inspired by geerlingguy/mac-dev-playbook).

License

This software is available under the following licenses:

MIT

windows-playbook's People

Contributors

Stargazers

Watchers

Forkers

jantari iamsergiy simengineering poghosyanstepan deepbeat justinhachemeister goffinet jedibrown donny3000 kz6fittycent wurzelmann simperdy edillmann weetgeen networkrezaakbari servo56 maxime1907 m8e cyborganizer1 rarrouba sdcoil skowalczyk drgeb vitran96 dee1337 rdg88 paulschmeida cuivienor boxedlunch-us josousa82 ambikappant fabricesemti80 marchandpatrick kainoad llopes-86 maxcaminer jessegit fpalen jmdarling xerhaxs denmarkgit manny-rodriguez aqader mbuschgens stkrzysiak jcohen-io louisktari 4kp3n pirenga computedocean bmarinov vario35 bcordlerossvideo

windows-playbook's Issues

Windows Installation

Is it possible to also install windows itself via ansible in the first place?

Automate Start menu and taskbar layout

How do I install from url using choco_installed_packages in default.config.yml?

Hi there,

I'm trying to setup my gaming pc using your ansible playbook.
And I'm looking to install some software that isn't in the chocolatey package repository.

Do you perhaps know how I can use this ansible playbook to download a msi from the internet and install it? I'm a bit new to ansible, sorry for the issue creation.

Sorry if this is not meant to be put in this issue list.

Problem

The problem is when I run the playbook from WSL2 trying to connect to windows, neither WinRM, nor SSH would work.

I have winrm working on Powershell, I have run your setup script as described to install OpenSSH.

Setup

This is my inventory:

windows:
  hosts:
    thor:
      ansible_host: <hostname>
      ansible_user: <my_user>
      ansible_password: <my_win_pwd>
      ansible_connection: winrm
      ansible_shell_type: cmd

Running just a simple ping playbook with `ansible-playbook ping.yml -i inventory.yml -vvv

- name: 'Testing'
  hosts: windows
  tasks:
    - name: "Ping"
      ansible.builtin.ping:

Output

returns:

ansible-playbook [core 2.16.5]
  config file = /home/loki/.dotfiles/ansible/windows-playbook/ansible.cfg
  configured module search path = ['/home/loki/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/loki/.local/lib/python3.10/site-packages/ansible
  ansible collection location = /home/loki/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible-playbook
  python version = 3.10.12 (main, Nov 20 2023, 15:14:05) [GCC 11.4.0] (/usr/bin/python3)
  jinja version = 3.1.3
  libyaml = True
Using /home/loki/.dotfiles/ansible/windows-playbook/ansible.cfg as config file
host_list declined parsing /home/loki/.dotfiles/ansible/windows-playbook/inventory.yml as it did not pass its verify_file() method
script declined parsing /home/loki/.dotfiles/ansible/windows-playbook/inventory.yml as it did not pass its verify_file() method
Parsed /home/loki/.dotfiles/ansible/windows-playbook/inventory.yml inventory source with yaml plugin
redirecting (type: callback) ansible.builtin.yaml to community.general.yaml
redirecting (type: callback) ansible.builtin.yaml to community.general.yaml
Skipping callback 'default', as we already have a stdout callback.
Skipping callback 'minimal', as we already have a stdout callback.
Skipping callback 'oneline', as we already have a stdout callback.

PLAYBOOK: ping.yml *********************************************************************************************************
1 plays in ping.yml

PLAY [Testing] *************************************************************************************************************

TASK [Gathering Facts] *****************************************************************************************************
task path: /home/loki/.dotfiles/ansible/windows-playbook/ping.yml:1
redirecting (type: modules) ansible.builtin.setup to ansible.windows.setup
Using module file /usr/lib/python3/dist-packages/ansible_collections/ansible/windows/plugins/modules/setup.ps1
Pipelining is enabled.
<thor> ESTABLISH WINRM CONNECTION FOR USER: <user> on PORT 5986 TO thor
fatal: [thor]: UNREACHABLE! => changed=false
  msg: 'ssl: HTTPSConnectionPool(host=''thor'', port=5986): Max retries exceeded with url: /wsman (Caused by NewConnectionError(''<urllib3.connection.HTTPSConnection object at 0x7f9e91f95bd0>: Failed to establish a new connection: [Errno 111] Connection refused''))'
  unreachable: true

PLAY RECAP *****************************************************************************************************************
thor                       : ok=0    changed=0    unreachable=1    failed=0    skipped=0    rescued=0    ignored=0

Running your main.yml, it won't find win_powershell:

ansible-playbook [core 2.16.5]
  config file = /home/loki/.dotfiles/ansible/windows-playbook/ansible.cfg
  configured module search path = ['/home/loki/.ansible/plugins/modules', '/usr/share/ansible/plugins/modules']
  ansible python module location = /home/loki/.local/lib/python3.10/site-packages/ansible
  ansible collection location = /home/loki/.ansible/collections:/usr/share/ansible/collections
  executable location = /usr/bin/ansible-playbook
  python version = 3.10.12 (main, Nov 20 2023, 15:14:05) [GCC 11.4.0] (/usr/bin/python3)
  jinja version = 3.1.3
  libyaml = True
Using /home/loki/.dotfiles/ansible/windows-playbook/ansible.cfg as config file
host_list declined parsing /home/loki/.dotfiles/ansible/windows-playbook/inventory.yml as it did not pass its verify_file() method
script declined parsing /home/loki/.dotfiles/ansible/windows-playbook/inventory.yml as it did not pass its verify_file() method
Parsed /home/loki/.dotfiles/ansible/windows-playbook/inventory.yml inventory source with yaml plugin
Read vars_file 'default.config.yml'
statically imported: /home/loki/.dotfiles/ansible/windows-playbook/tasks/hostname.yml
Read vars_file 'default.config.yml'
statically imported: /home/loki/.dotfiles/ansible/windows-playbook/tasks/updates.yml
Read vars_file 'default.config.yml'
statically imported: /home/loki/.dotfiles/ansible/windows-playbook/tasks/debloat.yml
Read vars_file 'default.config.yml'
statically imported: /home/loki/.dotfiles/ansible/windows-playbook/tasks/chocolatey.yml
Read vars_file 'default.config.yml'
statically imported: /home/loki/.dotfiles/ansible/windows-playbook/tasks/winget.yml
ERROR! couldn't resolve module/action 'ansible.windows.win_powershell'. This often indicates a misspelling, missing collection, or incorrect module path.

The error appears to be in '/home/loki/.dotfiles/ansible/windows-playbook/tasks/winget.yml': line 2, column 3, but may
be elsewhere in the file depending on the exact syntax problem.

The offending line appears to be:

---
- name: Install winget packages.
  ^ here

What am I doing wrong?

How can I connect to my windows host? It shouldn't be any different connecting from WSL2.

Add task to automate power plan of a Windows system

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.