Skip to content

Commit f9cdffd

Browse files
committed
wip
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
1 parent 2c98836 commit f9cdffd

File tree

16 files changed

+41
-299
lines changed

16 files changed

+41
-299
lines changed

docs/content/en/blog/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Blog
3-
menu: {main: {weight: 30}}
3+
menu: {main: {weight: 2}}
44
---
55

66
This is the **blog** section. It has two categories: News and Releases.

docs/content/en/community/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Community
3-
menu: {main: {weight: 40}}
3+
menu: {main: {weight: 3}}
44
---
55

66
<!--add blocks of content here to add more sections to the community page -->

docs/content/en/docs/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
title: Documentation
33
linkTitle: Docs
4-
menu: {main: {weight: 20}}
5-
weight: 20
4+
menu: {main: {weight: 1}}
5+
weight: 1
66
---
77

88

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Documentation
3+
weight: 40
4+
---

docs/content/en/docs/architecture/_index.md renamed to docs/content/en/docs/documentation/architecture.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Architecture and Internals
3-
weight: 90
3+
weight: 59
44
---
55

6-
76
This document gives an overview of the internal structure and components of Java Operator SDK core,
87
in order to make it easier for developers to understand and contribute to it. This document is
98
not intended to be a comprehensive reference, rather an introduction to the core concepts and we

docs/content/en/docs/configuration/_index.md renamed to docs/content/en/docs/documentation/configuration.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,8 @@
11
---
2-
title: Configuring JOSDK
3-
layout: docs
4-
permalink: /docs/configuration
2+
title: Configurations
3+
weight: 56
54
---
65

7-
# Configuration options
8-
96
The Java Operator SDK (JOSDK) provides several abstractions that work great out of the
107
box. However, while we strive to cover the most common cases with the default behavior, we also
118
recognize that that default behavior is not always what any given user might want for their

docs/content/en/docs/dependent-resources/_index.md renamed to docs/content/en/docs/documentation/dependent-resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Dependent Resources
3-
weight: 60
3+
weight: 51
44
---
55

66
## Motivations and Goals

docs/content/en/docs/features/_index.md renamed to docs/content/en/docs/documentation/features.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
---
22
title: Features
3-
weight: 50
3+
weight: 41
44
---
55

6-
# Features
7-
86
The Java Operator SDK (JOSDK) is a high level framework and related tooling aimed at
97
facilitating the implementation of Kubernetes operators. The features are by default following
108
the best practices in an opinionated way. However, feature flags and other configuration options

docs/content/en/docs/workflows/_index.md renamed to docs/content/en/docs/documentation/workflows.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Workflows
3-
weight: 70
3+
weight: 52
44
---
55

66
## Overview
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
---
22
title: Getting started
3+
weight: 5
34
---
Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Bootstrapping and samples
3-
weight: 30
3+
weight: 12
44
---
55

66
## Generating Project Skeleton
@@ -11,30 +11,28 @@ Project includes a maven plugin to generate a skeleton project:
1111
mvn io.javaoperatorsdk:bootstrapper:[version]:create -DprojectGroupId=org.acme -DprojectArtifactId=getting-started
1212
```
1313

14+
You can build this project with maven,
15+
the build will generate also the [CustomResourceDefinition](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions)
16+
for you.
17+
1418
## Getting started with samples
1519

16-
The easiest way to get started with SDK is to start
17-
[minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) and
18-
execute one of our [examples](https://github.com/java-operator-sdk/java-operator-sdk/tree/main/sample-operators).
19-
There is a dedicated page to describe how to [use the samples](/docs/using-samples).
20-
21-
Here are the main steps to develop the code and deploy the operator to a Kubernetes cluster.
22-
A more detailed and specific version can be found under `samples/mysql-schema/README.md`.
23-
24-
25-
- Setup `kubectl` to work with your Kubernetes cluster of choice.
26-
- Apply Custom Resource Definition
27-
- Compile the whole project (framework + samples) using `mvn install` in the root directory
28-
- Run the main class of the sample you picked and check out the sample's README to see what it
29-
does. When run locally the framework will use your Kubernetes client configuration (in `~/.
30-
kube/config`) to establish a connection to the cluster. This is why it was important to set
31-
up `kubectl` up front.
32-
- You can work in this local development mode to play with the code.
33-
- Build the Docker image and push it to the registry
34-
- Apply RBAC configuration
35-
- Apply deployment configuration
36-
- Verify if the operator is up and running. Don't run it locally anymore to avoid conflicts in
37-
processing events from the cluster's API server.
20+
You can find examples under [sample-operators](https://github.com/java-operator-sdk/java-operator-sdk/tree/master/sample-operators)
21+
directory which are intended to demonstrate the usage of different components in different scenarios, but mainly are more real world
22+
examples:
23+
24+
* *webpage*: Simple example creating an NGINX webserver from a Custom Resource containing HTML code. We provide more
25+
flavors of implementation, both with the low level APIs and higher level abstractions.
26+
* *mysql-schema*: Operator managing schemas in a MySQL database. Shows how to manage non Kubernetes resources.
27+
* *tomcat*: Operator with two controllers, managing Tomcat instances and Webapps running in Tomcat. The intention
28+
with this example to show how to manage multiple related custom resources and/or more controllers.
29+
30+
The easiest way to run / try out is to run one of the samples on
31+
[minikube](https://kubernetes.io/docs/tasks/tools/install-minikube/) or [kind](https://kind.sigs.k8s.io/).
32+
After applying the generated CRD, you can simply run your main class. The controller will automatically
33+
start communicate with you local Kubernetes cluster and reconcile custom resource after you create one.
34+
35+
See also detailed instructions under [`samples/mysql-schema/README.md`](https://github.com/operator-framework/java-operator-sdk/blob/main/sample-operators/mysql-schema/README.md).
3836

3937

4038

docs/content/en/docs/getting-started/intro-to-operators.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Introduction to Kubernetes operators
3-
weight: 20
3+
weight: 11
44
---
55

66
## Introduction & Resources

docs/content/en/docs/patterns-and-best-practices/_index.md renamed to docs/content/en/docs/getting-started/patterns-best-practices.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
2-
title: Patterns and Best Practices
3-
weight: 25
2+
title: Patterns and best practices
3+
weight: 13
44
---
55

6-
76
This document describes patterns and best practices, to build and run operators, and how to
87
implement them in terms of the Java Operator SDK (JOSDK).
98

docs/content/en/docs/glossary/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: Glossary
3-
weight: 40
3+
weight: 70
44
---
55

66
- **Primary Resource** - the resource that represents the desired state that the controller is
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
---
22
title: Migrations
3+
weight: 150
34
---
45

0 commit comments

Comments
 (0)