How-To Guides

Teaches Microcks' capabilities at a high level

Welcome to Microcks Guides! Our Guides section teaches Microcks' capabilities and features at a high level. It should help you get something done, correctly and safely.

🗃Installation

Pick your install: Docker Desktop, Compose, local Kubernetes with Helm, or the Operator.

• As a Docker Desktop Extension
• With Docker Compose
• With Podman Compose
• On Kind with Helm
• On Minikube with Helm
• On Kubernetes with Operator
• + 1 more…

🗃Usage

Import APIs, then tune mocks: dispatchers, delays, state, constraints, callbacks and more.

• Importing Services & APIs
• Setting custom dispatcher
• Applying constraints to mocks
• Defining delays for mocks
• Configuring stateful mocks
• Simulating OpenAPI Callbacks
• + 4 more…

🗃Automation

Drive Microcks from code and CI: REST API, CLI, GitHub, GitLab, Jenkins and Tekton.

• Connecting to Microcks API
• Using Microcks CLI
• Using GitHub Actions
• Using Jenkins Pipeline
• Using GitLab CI
• Using Tekton Pipeline

🗃Integration

Plug Microcks into the AI Copilot, Microcks Hub, Backstage and Postman Workspaces.

• Enabling the AI Copilot
• Integrating with Microcks Hub
• Configuring the Backstage Plugin
• Connecting to Postman Workspaces

🗃Administration

Manage users and roles, organize the repository, store secrets and take snapshots.

• Organizing Repository
• Managing Users
• Accessing secured Resources
• Snapshotting/restoring Repository

📄️Troubleshooting

Fixes for common issues: changing log levels, failed or empty imports, unresolved $ref.

💡 Remember

Contribute to Microcks Guides

Code isn't the only way to contribute to OSS; Dev Docs are a huge help that benefits the entire OSS ecosystem. At Microcks, we value Doc contributions as much as every other type of contribution. ❤️

To get started as a Docs contributor:

1. Familiarize yourself with our project's Contribution Guide and our Code of Conduct
2. Head over to our Microcks Docs Board
3. Pick an issue you would like to contribute to and leave a comment introducing yourself. This is also the perfect place to leave any questions you may have on how to get started
4. If there is no work done on that Docs issue yet, feel free to open a PR and get started!

Docs contributor questions

Do you have a documentation contributor question and you're wondering how to tag me into a GitHub discussion or PR? Have no fear!

Join us on Discord and use the #documentation channel to ping us!