azure-init

KO | EN

gitlite — search

#hacktoberfest #ai #llm #linux #docker #windows #awesome #awesome-list #vue #pytorch #security #mcp #ios #open-source

(★ 15)

A minimal provisioning agent designed for Azure Linux VMs.

azure-init Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Azure-Init

[![Github CI](https://github.com/Azure/azure-init/actions/workflows/ci.yaml/badge.svg)](https://github.com/Azure/azure-init/actions)

A reference implementation for provisioning Linux VMs on Azure.

## What is Azure-init?

Azure-init is a lightweight provisioning agent that configures Linux virtual machines using Azure metadata.
Azure-init is suitable for systems which do not require the full feature set that cloud-init provides. 
It is a modern, rust-based replacement for the WALinuxAgent provisioning agent to:

- Configure admin user account
- Write SSH keys for authentication
- Set the hostname
- Report ready to Azure wireserver

Azure-init is designed to be minimal, fast, and reliable, with very few dependencies.
This allows it to run in the early stages of the boot process when initializing Linux VMs in Azure.

## Key Features

- **Minimal footprint**: Small binary size and few dependencies
- **Fast execution**: Optimized for quick VM provisioning
- **Early boot compatibility**: Can run in very early boot stages
- **Azure-specific**: Tailored for the Azure environment
- **Configurable**: Allows customization through configuration files
- **Telemetry**: Provides KVP-based telemetry for the provisioning process which is used to report detailed errors for some classes of provisioning failures, such as networking failures

## Architecture

Azure-init consists of two main components:

1. **azure-init** - The main provisioning agent run on Azure VMs.
2. **libazureinit** - A library that provides core functionality for accessing provisioning functionality and Azure services.

The agent communicates with the Azure Instance Metadata Service (IMDS) to retrieve VM-specific configuration data, and then applies the appropriate configurations to the Linux system.

## Supported Distros

Azure-init is fully tested and supported on:
- Ubuntu 24.04
- Debian 13
- Azure Linux 3.0

These distributions provide full compatibility with all Azure-init features, including SSH configuration detection via `sshd -G`.

**Note:** Ubuntu 22.04 and Debian 12 have a known issue where the `sshd -G` command is not supported and is unable to query the correct path for the SSH keys. In these cases, Azure-init will then show a warning in the logs but fall back to [default SSH configuration paths](./doc/configuration.md#ssh-configuration) to continue .

## Getting Started

For step-by-step instructions on installing, configuring, and using azure-init, please refer to our [Getting Started Guide](doc/getting_started.md).

### Prerequisites

- Rust programming environment
- Access to an Azure subscription (for e2e testing)

### Installing Rust

To install Rust see here: https://www.rust-lang.org/tools/install.

## Building the Project

Building this project can be done by going to the base of the repository in the command line and entering the command `cargo build --all`.
This project contains two binaries, the main provisioning agent and the functional testing binary, so this command builds both.
These binaries are quite small, but you can build only one by entering `cargo build --bin <binary_name>` and indicating either `azure-init` or `functional_tests`.

To run the program, you must enter the command `cargo run --bin <binary_name>` and indicating the correct binary.

## Documentation

| Document | Description |
|----------|-------------|
| [Getting Started Guide](doc/getting_started.md) | Step-by-step instructions for new users |
| [Configuration Guide](doc/configuration.md) | Detailed configuration options and file structure |
| [Tracing System](doc/libazurekvp.md) | Understanding the telemetry and tracing capabilities |
| [End-to-End Testing](doc/e2e_testing.md) | How to perform comprehensive system testing |
| [Library Documentation](libazureinit/README.md) | Documentation for the libazureinit library |

## Configuration

Azure-init supports customization through configuration files.
The default configuration path is `/etc/azure-init/azure-init.toml`, but additional configuration can be provided in the `/etc/azure-init/azure-init.toml.d/` directory.

For detailed information about configuration options and structure, see [Configuration Documentation](doc/configuration.md).

## Testing

Azure-init includes two types of tests: unit tests and end-to-end (e2e) tests.

### Running Unit Tests

From the root directory of the repository, run:

```
cargo test --verbose --all-features --workspace
```

This command runs unit tests across all libraries in the repository — not just for azure-init.
Running the full suite ensures your local testing environment mirrors what’s executed in the CI pipeline.

### Running End-to-End (e2e) Tests
Please refer to [e2e_testing.md](doc/e2e_testing.md) for end-to-end testing.

## Contributing

Contributions require you to agree to Microsoft's Contributor License Agreement (CLA).
Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for detailed instructions.

This project adheres to the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
Check out [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for a brief collection of links and references.

## Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
trademarks or logos is subject to and must follow 
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
Any use of third-party trademarks or logos are subject to those third-party's policies.

## libazureinit

For common library used by this reference implementation, please refer to [libazureinit](https://github.com/Azure/azure-init/tree/main/libazureinit/).

azure-init

azure-init Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

azure-init

azure-init Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README