{"id":20677810,"url":"https://github.com/clivern/opswork","last_synced_at":"2025-04-19T21:04:23.111Z","repository":{"id":86321786,"uuid":"164674696","full_name":"Clivern/OpsWork","owner":"Clivern","description":"🔥 OpsWork Swiss Knife!","archived":false,"fork":false,"pushed_at":"2024-10-04T20:04:14.000Z","size":7344,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-04T20:06:38.023Z","etag":null,"topics":["clivern","opswork","opsworks"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Clivern.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGELOG.rst","contributing":"CONTRIBUTING.rst","funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.rst","dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"custom":"clivern.com/sponsor/"}},"created_at":"2019-01-08T15:11:58.000Z","updated_at":"2024-09-11T17:23:22.000Z","dependencies_parsed_at":"2023-12-01T21:23:18.393Z","dependency_job_id":"4d22491e-660b-47df-9c01-cfdec731b93f","html_url":"https://github.com/Clivern/OpsWork","commit_stats":null,"previous_names":["clivern/opswork"],"tags_count":31,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clivern%2FOpsWork","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clivern%2FOpsWork/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clivern%2FOpsWork/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clivern%2FOpsWork/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Clivern","download_url":"https://codeload.github.com/Clivern/OpsWork/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224969894,"owners_count":17400295,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["clivern","opswork","opsworks"],"created_at":"2024-11-16T21:17:10.804Z","updated_at":"2025-04-19T21:04:23.093Z","avatar_url":"https://github.com/Clivern.png","language":"Python","readme":".. image:: https://img.shields.io/pypi/v/opswork.svg\n    :alt: PyPI-Server\n    :target: https://pypi.org/project/opswork/\n.. image:: https://github.com/clivern/opswork/actions/workflows/ci.yml/badge.svg\n    :alt: Build Status\n    :target: https://github.com/clivern/opswork/actions/workflows/ci.yml\n.. image:: https://static.pepy.tech/badge/opswork\n    :alt: Downloads\n    :target: https://pepy.tech/projects/opswork\n\n|\n\n=======\nOpsWork\n=======\n\nTo use opswork, follow the following steps:\n\n1. Create a python virtual environment or use system wide environment\n\n.. code-block::\n\n    $ python3 -m venv venv\n    $ source venv/bin/activate\n\n\n2. Install opswork package with pip.\n\n.. code-block::\n\n    $ pip install opswork\n\n\n3. Get opswork command line help\n\n.. code-block::\n\n    $ opswork --help\n\n\n4. Init the config file and the sqlite database\n\n.. code-block::\n\n    $ opswork config init\n\n\n5. To edit configs\n\n.. code-block::\n\n    $ opswork config init\n\n\n6. Add a recipe\n\n.. code-block::\n\n    $ opswork recipe add \u003crecipe_name\u003e -p \u003crecipe_relative_path\u003e\n\n    # Some examples\n    $ opswork recipe add clivern/ping -p recipe/ping -f\n    $ opswork recipe add clivern/nginx -p recipe/nginx -f\n    $ opswork recipe add clivern/motd -p recipe/motd -f\n    $ opswork recipe add clivern/cmd -p recipe/cmd -f\n    # From remote git\n    $ opswork recipe add clivern/dotfiles/update -p git@github.com:clivern/dotfiles.git -s brew/update -t dotfiles -f\n\n\n7. To list recipes\n\n.. code-block::\n\n    $ opswork recipe list\n\n    # Get recipes as a JSON\n    $ opswork recipe list -o json | jq .\n\n\n8. To get a recipe\n\n.. code-block::\n\n    $ opswork recipe get \u003crecipe_name\u003e\n\n\n9. To delete a recipe\n\n.. code-block::\n\n    $ opswork recipe delete \u003crecipe_name\u003e\n\n\n10. Add a host\n\n.. code-block::\n\n    $ opswork host add \u003chost_name\u003e -i \u003chost_ip\u003e -p \u003cssh_port\u003e -u \u003cssh_username\u003e -s \u003cssh_key_path\u003e\n\n    # Add a remote host\n    $ opswork host add example.com -i 127.0.0.1 -p 22 -u root -s /Users/root/.ssh/id_rsa.pem\n\n    # Add the localhost\n    $ opswork host add localhost -i localhost -c local\n\n\n11. To list hosts\n\n.. code-block::\n\n    $ opswork host list\n\n    # Get hosts as a JSON\n    $ opswork host list -o json | jq .\n\n\n12. To get a host\n\n.. code-block::\n\n    $ opswork host get \u003chost_name\u003e\n\n\n13. To SSH into a host\n\n.. code-block::\n\n    $ opswork host ssh \u003chost_name\u003e\n\n\n14. To delete a host\n\n.. code-block::\n\n    $ opswork host delete \u003chost_name\u003e\n\n\n15. Run a recipe towards a host\n\n.. code-block::\n\n    $ opswork recipe run \u003crecipe_name\u003e -h \u003chost_name\u003e -v key=value\n\n    # Some examples\n    $ opswork recipe run clivern/nginx -h example.com\n    $ opswork recipe run clivern/ping -h localhost\n\n\n16. To generate a random password\n\n.. code-block::\n\n    $ opswork random password 8\n\n\n17. To add a secret\n\n.. code-block::\n\n    $ opswork secret add \u003csecret/name\u003e \u003csecret_value\u003e -t \u003ctag\u003e\n\n    $ opswork secret add clivern/cloud_provider/api_key xxxx-xxxx-xxxx-xxxx -t cloud_provider\n\n\n18. To list secrets\n\n.. code-block::\n\n    $ opswork secret list -o json\n\n\n19. To get a secret\n\n.. code-block::\n\n    $ opswork secret get \u003csecret_name\u003e\n\n    # For example\n    $ opswork secret get clivern/cloud_provider/api_key\n\n\n20. To delete a secret\n\n.. code-block::\n\n    $ opswork secret delete \u003csecret_name\u003e\n\n    # For example\n    $ opswork secret delete clivern/cloud_provider/api_key\n","funding_links":["clivern.com/sponsor/"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclivern%2Fopswork","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclivern%2Fopswork","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclivern%2Fopswork/lists"}