A comprehensive suite of tools and services for managing and monitoring Internet Computer (IC) infrastructure.
Comprehensive, searchable documentation is available at dfinity.github.io/dre
The documentation includes:
- Detailed API references
- Usage examples
- Best practices
- Troubleshooting guides
DRE provides a powerful set of tools and services:
-
DRE CLI Tool: Command-line interface for interacting with IC infrastructure
- Available as a pre-built binary on GitHub Releases
- Examples available in NNS proposals documentation
-
DRE Dashboard: Comprehensive monitoring and management interface
- Frontend and backend components
- Real-time infrastructure insights
- Interactive management capabilities
- Service Discovery: Automated IC target discovery for logs and metrics
- Log Fetchers:
- Host node logs
- Guest node logs
- Boundary node logs
- Canister logs
- Node Provider Notifications: Health monitoring system for IC nodes
- Automated alerts for node health issues
- Note: Currently in maintenance mode
- Check the prerequisites
- Follow our detailed getting started guide
- Verify your installation
The DRE CLI tool (version 0.5.9) provides various commands for managing IC infrastructure:
# View all available commands
dre --help
# Common commands:
dre network # Network-wide management operations, such as healing all subnets
dre subnet # Subnet management, such as replacing nodes in a subnet
dre governance # Commands and actions related to the IC NNS governance, such as submitting NNS motion proposals
dre proposals # Listing or analyzing submitted NNS proposals
dre nodes # Node operations, such as removing nodes from the IC
dre registry # Registry reading
dre get # Wrapper around ic-admin get-* commands
dre propose # Wrapper around ic-admin propose-* commands
dre firewall # Submitting proposals for firewall updates
dre node-metrics # Getting the trustworthy node metrics
dre update-authorized-subnets # Automatically updating the list of public IC subnets, based on subnet utilization
dre neuron # Neuron topping up and checking balance--private-key-pem: Path to private key file (PEM format)--neuron-id: Explicitly setting the Neuron ID for governance operations, overriding the autodetection--network: Target network (mainnet, staging, or testnet)--ic-admin: Custom path to ic-admin--hsm-*: Hardware Security Module configurations
--verbose: Print detailed information--dry-run: Simulate operations without execution--offline: Run operations offline when possible-y, --yes: Skip confirmation prompts
For more examples and detailed usage instructions:
- Browse the documentation
- Check the NNS proposals guide
- Use the documentation search feature for specific topics
We welcome contributions! Please see our contributing guide for details on:
- Code style and standards
- Development setup
- Testing requirements
- Pull request process
This project is licensed under the Apache License 2.0.
Built with ❤️ by the DFINITY Foundation