Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stateful/vscode-runme
DevOps Notebooks Built with Markdown - VS Code extension
https://github.com/stateful/vscode-runme
bash devops markdown notebook runbooks shell typescript vscode vscode-extension
Last synced: about 2 months ago
JSON representation
DevOps Notebooks Built with Markdown - VS Code extension
- Host: GitHub
- URL: https://github.com/stateful/vscode-runme
- Owner: stateful
- License: apache-2.0
- Created: 2022-09-22T18:40:13.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T00:36:41.000Z (about 2 months ago)
- Last Synced: 2024-10-30T00:43:27.081Z (about 2 months ago)
- Topics: bash, devops, markdown, notebook, runbooks, shell, typescript, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://runme.dev
- Size: 53.6 MB
- Stars: 195
- Watchers: 5
- Forks: 16
- Open Issues: 65
-
Metadata Files:
- Readme: README-platform.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Stateful for [Visual Studio Code](https://code.visualstudio.com/) [](https://github.com/stateful/vscode-runme/actions/workflows/test.yml)
Stateful provides a powerful set of tools for creating, running, discovering, storing, and sharing DevOps Notebooks. These Notebooks offer a new way of codifying engineering processes by integrating code/commands, configurations, secrets, and cloud-native tools/services. The platform enables secure collaboration using these Notebooks and their metadata to build a knowledge-base focused on streamlining DevOps.
## Overview
Stateful combines the power of interactive DevOps Notebooks with a robust set of features designed to streamline your development and operational processes. There are two major pieces:
- **Stateful Extension**: A super set of the open-source Runme project, offering enhanced features for authentication, collaboration, and security, making it ideal for teams and enterprises.
- **Stateful Platform**: A SaaS solution that integrates with GitHub and Slack, serving as a collaboration hub for finding, launching, running, sharing, and troubleshooting Notebooks and their metadata.
## Key Features
### DevOps Notebooks
- **Rich Code Execution**: Execute code in real-time with support for multiple programming languages.
- **Data Visualization**: Integrate powerful visualization tools to create insightful data representations.
- **Collaboration**: Share DevOps Notebooks and collaborate with team members in real-time.
### Platform
The Stateful platform offers a suite of tools and services designed to enhance your development lifecycle.
- **Believe in Your Docs Again**: Transform your documentation into actionable, GitOps-compatible, cloud-native DevOps Notebooks that are collaborative and searchable.
- **Markdown and VS Code Integration**: Repurpose your existing engineering docs (READMEs, runbooks, etc.) by making commands runnable and configurable, stored next to code in Git.
- **Knowledge-Base for DevOps**: Search across Git repositories to find the necessary DevOps Notebook, explore historical sessions, commands, diffs, conversations, and metadata to accelerate investigations.
- **Team Collaboration**: Set up groups and permissions to share DevOps Notebook sessions and metadata with other engineers. Participate in discussion threads and escalate issues to Slack.
- **Visibility and Observability**: Analyze the health and structure of your DevOps processes with secure activity logs, and integrate with observability tools for flexible data use.
- **Enterprise-Ready Security**: Integrated with IAM tools like Okta, Active Directory, and Google Workspace for frictionless access provisioning and secure data storage with end-to-end encryption.
### Features
- **Runnable Engineering Docs**: Launch Markdown files from GitHub as runnable DevOps Notebooks, saving sessions to the Stateful platform.
- **Easy Discovery**: Quickly locate and launch DevOps Notebooks from your GitHub organization with one click to open in VS Code, clone the repo, and start running.
- **History and Metadata**: Automatically save commands, metadata, outputs, and history to Stateful. Search your history, see diffs, share, and troubleshoot processes.
- **Slack Integration**: Easily escalate or share DevOps Notebooks and commands on Slack for team troubleshooting and discussion.
- **Backstage Plugin**: View activity feeds, search, and launch project docs directly into runnable DevOps Notebooks with the Stateful plugin for Backstage.
- **Activity Overview**: Get a quick overview of team DevOps activities and request details for outage investigations with one click.
- **Robust Team Management**: Streamlined user and group management with permissions for sensitive workflows to avoid costly accidents, integrated with key enterprise tools like SIEM.
## Getting Started
1. **Sign Up**: Create your free account at [Stateful](https://platform.stateful.com/).
2. **Install VS Code Extension**: Download the Stateful extension from the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=stateful.platform). The extension is fully compatible with Runme, but adds authentication, collaboration, and security features, making it secure for teams and inside companies.
3. **Explore**: Start creating, running, sharing, and discussing your first DevOps Notebook and its commands using the Stateful platform.
For detailed documentation and tutorials, visit our [Documentation](https://stateful.com/docs).
## Learn More About Runme
To learn more about the open-source Runme project and join the community, visit [runme.dev](https://runme.dev).
## Community and Support
- **Join Our Community**: Connect with other developers and get support on our [Discord](https://discord.gg/stateful).
- **Support**: For additional help, visit our [Support page](https://stateful.com/support) to contact us via email or Discord.