Skip to content

Commit

Permalink
docs: fix links (#255)
Browse files Browse the repository at this point in the history
  • Loading branch information
haoxins authored Feb 10, 2022
1 parent cca694e commit 6fd9615
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/crd_v1alpha1.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# FlinkCluster Custom Resource Definition - v1alpha1

The Kubernetes Operator for Apache Flink uses [CustomResourceDefinition](https://kubernetes.io/docs/concepts/api-extension/custom-resources/)
The Kubernetes Operator for Apache Flink uses [CustomResourceDefinition](https://kubernetes.io/docs/concepts/api-extension/custom-resources/)
named `FlinkCluster` for specifying a Flink job cluster ([sample](../config/samples/flinkoperator_v1beta1_flinkjobcluster.yaml))
or Flink session cluster ([sample](../config/samples/flinkoperator_v1beta1_flinksessioncluster.yaml)), depending on
whether the job spec is specified. Similarly to other kinds of Kubernetes resources, the custom resource consists of a
resource `Metadata`, a specification in a `Spec` field and a `Status` field. The definitions are organized in the
following structure. The v1beta1 version of the API definition is implemented [here](../api/v1beta1/flinkcluster_types.go).
following structure. The v1beta1 version of the API definition is implemented [here](../apis/flinkcluster/v1beta1/flinkcluster_types.go).

```
FlinkCluster
Expand Down
2 changes: 1 addition & 1 deletion docs/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ library. The project structure and boilerplate files are generated with
[Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder). Knowledge of
controller-runtime and Kubebuilder is required to understand this project.

The Flink custom resource is defined in Go struct [FlinkCluster](../api/v1beta1/flinkcluster_types.go),
The Flink custom resource is defined in Go struct [FlinkCluster](../apis/flinkcluster/v1beta1/flinkcluster_types.go),
then Kubebuild generates related Go files and YAML files, e.g.
[flinkclusters.yaml](../config/crd/bases/flinkoperator.k8s.io_flinkclusters.yaml).
The custom logic for reconciling a Flink custom resource is inside of the
Expand Down

0 comments on commit 6fd9615

Please sign in to comment.