|
6 | 6 | weight: 2 |
7 | 7 | --- |
8 | 8 |
|
9 | | -## Overview |
10 | | - |
11 | | -This project is a component of the [Operator Framework][of-home], an open source toolkit to manage Kubernetes native applications, called Operators, in an effective, automated, and scalable way. Read more in the [introduction blog post][of-blog]. |
12 | | - |
13 | | -[Operators][operator_link] make it easy to manage complex stateful applications on top of Kubernetes. However writing an operator today can be difficult because of challenges such as using low level APIs, writing boilerplate, and a lack of modularity which leads to duplication. |
14 | | - |
15 | | -The Operator SDK is a framework that uses the [controller-runtime][controller_runtime] library to make writing operators easier by providing: |
16 | | - |
17 | | - - High level APIs and abstractions to write the operational logic more intuitively |
18 | | - - Tools for scaffolding and code generation to bootstrap a new project fast |
19 | | - - Extensions to cover common operator use cases |
20 | | - |
21 | | -## Workflow |
22 | | - |
23 | | -The SDK provides workflows to develop operators in Go, Ansible, or Helm. |
24 | | - |
25 | | -The following workflow is for a new [Golang operator][golang-guide]: |
26 | | - |
27 | | - 1. Create a new operator project using the SDK Command Line Interface(CLI) |
28 | | - 2. Define new resource APIs by adding Custom Resource Definitions(CRD) |
29 | | - 3. Define Controllers to watch and reconcile resources |
30 | | - 4. Write the reconciling logic for your Controller using the SDK and controller-runtime APIs |
31 | | - 5. Use the SDK CLI to build and generate the operator deployment manifests |
32 | | - |
33 | | -The following workflow is for a new [Ansible operator][ansible-guide]: |
34 | | - |
35 | | - 1. Create a new operator project using the SDK Command Line Interface(CLI) |
36 | | - 2. Write the reconciling logic for your object using ansible playbooks and roles |
37 | | - 3. Use the SDK CLI to build and generate the operator deployment manifests |
38 | | - 4. Optionally add additional CRD's using the SDK CLI and repeat steps 2 and 3 |
39 | | - |
40 | | -The following workflow is for a new [Helm operator][helm-guide]: |
41 | | - |
42 | | - 1. Create a new operator project using the SDK Command Line Interface(CLI) |
43 | | - 2. Create a new (or add your existing) Helm chart for use by the operator's reconciling logic |
44 | | - 3. Use the SDK CLI to build and generate the operator deployment manifests |
45 | | - 4. Optionally add additional CRD's using the SDK CLI and repeat steps 2 and 3 |
46 | | - |
47 | | -## Command Line Interface |
48 | | - |
49 | | -To learn more about the SDK CLI, see the [SDK CLI Reference][sdk_cli_ref], or run `operator-sdk [command] -h`. |
50 | | - |
51 | | -### Operator capability level |
52 | | - |
53 | | -Note that each operator type has a different set of capabilities. When choosing what type to use for your project, it is important to understand the features and limitations of each of the project types and the use cases for your operator. |
54 | | - |
55 | | - |
56 | | - |
57 | | -Find more details about the various levels and the feature requirements for them in the [capability level documentation][capability_levels]. |
58 | | - |
59 | | -## Samples |
60 | | - |
61 | | -To explore any operator samples built using the operator-sdk, see the [operator-sdk-samples][samples]. |
62 | | - |
63 | | -## FAQ |
64 | | - |
65 | | -For common Operator SDK related questions, see the [FAQ][faq]. |
66 | | - |
67 | | -## Contributing |
68 | | - |
69 | | -See [CONTRIBUTING][contrib] for details on submitting patches and the contribution workflow. |
70 | | - |
71 | | -See the [proposal docs][proposals_docs] and issues for ongoing or planned work. |
72 | | - |
73 | | -## Reporting bugs |
74 | | - |
75 | | -See [reporting bugs][bug_guide] for details about reporting any issues. |
76 | | - |
77 | | -## License |
78 | | - |
79 | | -Operator SDK is under Apache 2.0 license. See the [LICENSE][license_file] file for details. |
80 | | - |
81 | | -[ansible-guide]:/docs/ansible/quickstart/ |
82 | | -[bug_guide]:/docs/contribution-guidelines/reporting-issues/ |
83 | | -[capability_levels]: /docs/operator-capabilities/ |
84 | | -[contrib]: https://github.com/operator-framework/operator-sdk/blob/master/CONTRIBUTING.MD |
85 | | -[controller_runtime]: https://github.com/kubernetes-sigs/controller-runtime |
86 | | -[faq]: /docs/faq/ |
87 | | -[getting_started]: https://github.com/operator-framework/getting-started/blob/master/README.md |
88 | | -[golang-guide]:/docs/golang/quickstart/ |
89 | | -[helm-guide]:/docs/helm/quickstart/ |
90 | | -[install_guide]: /docs/install-operator-sdk/ |
91 | | -[license_file]:https://github.com/operator-framework/operator-sdk/blob/master/LICENSE |
92 | | -[of-blog]: https://coreos.com/blog/introducing-operator-framework |
93 | | -[of-home]: https://github.com/operator-framework |
94 | | -[operator_link]: https://coreos.com/operators/ |
95 | | -[proposals_docs]: https://github.com/operator-framework/operator-sdk/tree/master/proposals |
96 | | -[samples]: https://github.com/operator-framework/operator-sdk-samples |
97 | | -[sdk_cli_ref]: /docs/cli/ |
0 commit comments