{"id":40976546,"url":"https://github.com/bougou/sail","last_synced_at":"2026-01-22T06:52:46.778Z","repository":{"id":46244525,"uuid":"396403964","full_name":"bougou/sail","owner":"bougou","description":"sail is an operation framework based on Ansible/Helm. sail follows the principles of Infrastructure as Code (IaC). So it is a tool for DevOps.","archived":false,"fork":false,"pushed_at":"2023-01-02T16:14:06.000Z","size":228,"stargazers_count":10,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-06-19T06:54:12.569Z","etag":null,"topics":["ansible","devops","helm","iac","oac"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bougou.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-15T15:52:07.000Z","updated_at":"2024-06-19T06:54:12.570Z","dependencies_parsed_at":"2023-02-01T03:30:56.433Z","dependency_job_id":null,"html_url":"https://github.com/bougou/sail","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/bougou/sail","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bougou%2Fsail","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bougou%2Fsail/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bougou%2Fsail/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bougou%2Fsail/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bougou","download_url":"https://codeload.github.com/bougou/sail/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bougou%2Fsail/sbom","scorecard":{"id":249016,"data":{"date":"2025-08-11","repo":{"name":"github.com/bougou/sail","commit":"d08c397cba068de8d265b1d46d81aabd23f93051"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.1,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"project is archived","details":["Warn: Repository is archived."],"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 1/26 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/branch_check.yml:1","Warn: no topLevel permission defined: .github/workflows/release.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/branch_check.yml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/bougou/sail/branch_check.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/branch_check.yml:18: update your workflow using https://app.stepsecurity.io/secureworkflow/bougou/sail/branch_check.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/bougou/sail/release.yml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/bougou/sail/release.yml/main?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/release.yml:24: update your workflow using https://app.stepsecurity.io/secureworkflow/bougou/sail/release.yml/main?enable=pin","Info:   0 out of   4 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   1 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":0,"reason":"Project has not signed or included provenance with any releases.","details":["Warn: release artifact v0.2.1 not signed: https://api.github.com/repos/bougou/sail/releases/53993785","Warn: release artifact v0.2.0 not signed: https://api.github.com/repos/bougou/sail/releases/52974418","Warn: release artifact v0.1.7 not signed: https://api.github.com/repos/bougou/sail/releases/52699227","Warn: release artifact v0.1.6 not signed: https://api.github.com/repos/bougou/sail/releases/51667653","Warn: release artifact v0.1.5 not signed: https://api.github.com/repos/bougou/sail/releases/51496537","Warn: release artifact v0.2.1 does not have provenance: https://api.github.com/repos/bougou/sail/releases/53993785","Warn: release artifact v0.2.0 does not have provenance: https://api.github.com/repos/bougou/sail/releases/52974418","Warn: release artifact v0.1.7 does not have provenance: https://api.github.com/repos/bougou/sail/releases/52699227","Warn: release artifact v0.1.6 does not have provenance: https://api.github.com/repos/bougou/sail/releases/51667653","Warn: release artifact v0.1.5 does not have provenance: https://api.github.com/repos/bougou/sail/releases/51496537"],"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 5 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-17T08:07:31.007Z","repository_id":46244525,"created_at":"2025-08-17T08:07:31.007Z","updated_at":"2025-08-17T08:07:31.007Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28657375,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T01:17:37.254Z","status":"online","status_checked_at":"2026-01-22T02:00:07.137Z","response_time":144,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["ansible","devops","helm","iac","oac"],"created_at":"2026-01-22T06:52:46.093Z","updated_at":"2026-01-22T06:52:46.772Z","avatar_url":"https://github.com/bougou.png","language":"Go","readme":"# sail\n\n[中文文档](./docs/zh/README.md)\n\n`sail` is an operation framework based on Ansible/Helm. `sail` follows the principles of ***Infrastructure as Code (IaC)***,  ***Operation as Code (OaC)***，and ***Everything as Code***. So it is a tool for ***DevOps***.\n\n\u003e `sail` is especially suitable for the privatization delivery of software products.\n\nAlthough `sail` strongly utilizes `Ansible` and `Helm`, `sail` does not write the ansible tasks or helm chart templates for you. It's still your responsibility to develop ansible tasks and helm templates files.\n\n\u003e - `Ansible` is for deploying to normal servers.\n\u003e - `Helm` is for deploying to Kubernetes.\n\n## Product and Target and Package\n\n`sail` has three main concepts: `Product`, `Target`, and `Package`\n\n### Product\n\nProduct is a specific software product. It is composed of components.\n\nA `Product` can be simple and small with just several components, or can be big and complex with hunderds of components.\n\nWhen you are responsible for managing and operating a software product, you should prepare the ***product operation code***. The operation code of a product is not the functional code that written by product developers. It is code that direct the operators to install and manage the product.\n\n### Target\n\nTarget represents the environment where the product softwares are installed and run.\n\nIn `sail`, we used two hierarchies to arrange environments.\n\nThe two hierarchies are:\n\n- `target`\n- `zone`\n\nA `zone` must be created under a specific `target` and there can be multiple `zone`(s) under a `target`. The `target(s)` are totally isolated from each other in `sail`.\n\n### Package\n\nPackage(s) are real software artifacts. They are normally compressed in some format, like `.rpm`, `.tar.gz`, `.gzip` ....\n\n## Use sail\n\nGenerally, you run `sail` on a centralized machine (deploy machine).\n\n```bash\n# Download sail binary file\n# Move sail binary file to a $PATH directory\n$ mv sail /usr/local/bin/\n$ chmod +x /usr/local/bin/sail\n```\n\nThe `sail` command uses three directories to do its job.\n\n- ***products-dir*** Store the operation code of product(s).\n- ***targets-dir*** Store the environment informations.\n- ***packages-dir*** Store package files.\n\nYou can specify them by command line options when running `sail`, like:\n\n```bash\n$ sail --products-dir /path/to/products --targets-dir /path/to/targets --packages-dir /path/to/packages \u003csubcommand\u003e\n```\n\nYou can also set them in `~/.sailrc.yaml` file to avoid typing them every time.\n\n```yaml\n# cat ~/.sailrc.yaml\nproducts-dir: /path/to/products\ntargets-dir: /path/to/targets\npackages-dir: /path/to/packages\n```\n\n\u003e Note, these three directories can be located at different places (that is not under a same parent dir).\n\n\u003e The `products-dir` contains all operation code of products(s). You should put your specific `\u003cproductName\u003e` dir under `products-dir` even if you only have one product. Normally, the content of products dir should be managed by git.\n\n\u003e The `targets-dir` keeps all configurations of environments. This dir should exists on the deploy machine.\n\n\u003e The `packages-dir` holds all package files. You can create recursive directories under it to store any files.\n\nTo use `sail` to do operation, you need to understand how to declare `product` and how to define the `component(s)` that make up of the `product`.\n\n## Why use sail\n\nUsing `sail`, you can change ***the operations of any products*** into the following commands:\n\n```bash\n# Create a target environment (target/zone)\n$ sail conf-create -t \u003ctargetname\u003e -z \u003czonename\u003e \\\n  -p \u003cproductname\u003e \\\n  --hosts \u003chosts-for-components\u003e \\\n  --hosts \u003chosts-for-components\u003e \\\n  ...\n\n# Deploy\n$ sail apply -t \u003ctargetname\u003e -z \u003czonename\u003e\n\n# Upgrade specific components\n$ sail upgrade -t \u003ctargetname\u003e -z \u003czonename\u003e \\\n  -c \u003ccomponentName1\u003e/\u003ccomponentVersion1\u003e \\\n  -c \u003ccomponentName2\u003e/\u003ccomponentVersion2\u003e\n```\n\n## Documents\n\n- [How to develop product operation code](./docs/en/product.md)\n- [How to develop component operation code](./docs/en/component.md)\n- [How to maintain cmdb for deploy target](./docs/en/cmdb.md)\n- [Sail command usage](./docs/en/sail-commands.md)\n- [QuickStart](./docs/quick-start.md)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbougou%2Fsail","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbougou%2Fsail","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbougou%2Fsail/lists"}