An open API service indexing awesome lists of open source software.

https://github.com/f5devcentral/vscode-f5-flipper

Exploring Citrix/NetScaler configs
https://github.com/f5devcentral/vscode-f5-flipper

Last synced: 2 months ago
JSON representation

Exploring Citrix/NetScaler configs

Awesome Lists containing this project

README

          

# F5 Flipper 🐬

**NetScaler to F5 Configuration Converter**

Analyze Citrix NetScaler/ADC configurations and convert them to F5 AS3 declarations with FAST templates.

**πŸ“– [Documentation](https://f5devcentral.github.io/vscode-f5-flipper/)**

![Project Flipper](project-flipper-dophin.png)

[![Visual Studio Marketplace](https://img.shields.io/visual-studio-marketplace/v/F5DevCentral.vscode-f5-flipper?style=flat-square&label=VS%20Code%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=F5DevCentral.vscode-f5-flipper)
[![Downloads](https://img.shields.io/visual-studio-marketplace/d/F5DevCentral.vscode-f5-flipper?style=flat-square)](https://marketplace.visualstudio.com/items?itemName=F5DevCentral.vscode-f5-flipper)

---

## ✨ Key Features

- πŸ“¦ **Parse NetScaler Configs** - Import `.conf` files or `.tgz` archives
- ⚑ **High Performance** - NEW RX parsing engine delivers 2-3x faster processing
- 🎯 **Application Abstraction** - Automatically extract CS/LB/GSLB applications
- πŸ“Š **Smart Diagnostics** - 40+ rules for feature detection and analysis
- πŸ”„ **AS3 Conversion** - Generate F5 AS3 declarations via FAST templates
- πŸ–₯️ **Interactive Webviews** - Monaco editor integration with live AS3 preview
- 🌐 **Protocol Support** - HTTP, SSL, TCP, UDP, DNS, and more

---

## πŸš€ Quick Start

1. **Install** the extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=F5DevCentral.vscode-f5-flipper)
2. **Open** a folder or click the browse button to select a NetScaler `.conf` or `.tgz` file
3. **Explore** abstracted applications in the F5 Flipper view
4. **Convert** applications to AS3 using FAST templates

F5 Flipper Demo

---

## 🎯 What It Does

F5 Flipper helps you migrate from Citrix NetScaler/ADC to F5 technologies by:

1. **Parsing** NetScaler configuration files into structured JSON
2. **Abstracting** applications with all their dependencies (monitors, pools, certificates, policies)
3. **Analyzing** configurations with diagnostic rules for feature detection
4. **Converting** to F5 AS3 declarations ready for deployment on BIG-IP

### Technology-Specific Diagnostics

Diagnostic rules are prefixed by target F5 technology:
- `XC-` - F5 Distributed Cloud
- `TMOS-` - F5 BIG-IP
- `NGINX-` - NGINX Plus

---

## πŸ“ Output Formats

- **AS3 Declarations** - Declarative JSON for F5 BIG-IP deployment
- **JSON Reports** - Complete configuration analysis and statistics
- **YAML Reports** - Human-readable application summaries
- **Application Views** - Interactive tree view with Monaco editors

---

## 🀝 Contributing

We welcome contributions! Whether you're interested in:

- πŸ“– Improving documentation
- πŸ” Tuning diagnostic rules
- πŸ’» Adding features or fixing bugs
- πŸ—ΊοΈ Mapping NetScaler features to F5 equivalents
- 🎨 Enhancing FAST templates

Check out the [GitHub Issues](https://github.com/f5devcentral/vscode-f5-flipper/issues) to see what's in progress or open a new issue to report bugs and request features.

---

## πŸ“š Documentation

- **[Documentation Site](https://f5devcentral.github.io/vscode-f5-flipper/)** - Full documentation with guides and examples
- [ROADMAP.md](ROADMAP.md) - Project roadmap and technical architecture
- [CHANGELOG.md](CHANGELOG.md) - Version history and release notes
- [CLAUDE.md](CLAUDE.md) - Development guidelines for contributors

---

## πŸ’‘ Recommended Extension

For enhanced NetScaler syntax highlighting, install [NetScaler by Tim Denholm](https://marketplace.visualstudio.com/items?itemName=timdenholm.netscaler) - works great alongside F5 Flipper!

---

## πŸ™ Acknowledgments

Special thanks to:
- **Tim Denholm** for the excellent NetScaler VS Code extension
- **F5 FAST Core** team for the template processing framework
- The open source community for feedback and contributions

---

## πŸ“„ License

[Apache License 2.0](LICENSE)

---

## πŸ”— Resources

- [F5 Application Services 3 (AS3)](https://clouddocs.f5.com/products/extensions/f5-appsvcs-extension/latest/)
- [F5 FAST Templates](https://github.com/f5networks/f5-appsvcs-templates)
- [NetScaler Documentation](https://docs.netscaler.com/)

---

**Built with ❀️ by F5 DevCentral**