Skip to content

Commit f5b7dfa

Browse files
final first draft of VZ section (#161)
* final first draft of VZ section * fix copy and paste error
1 parent ef268cd commit f5b7dfa

File tree

4 files changed

+39
-20
lines changed

4 files changed

+39
-20
lines changed

documentation/staging/1.3/content/navigate/_index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,10 @@ The UI sections are:
2727
- [WebLogic Domain]({{< relref "/navigate/kubernetes/k8s-weblogic-domain.md" >}})
2828
- [Ingress Controller]({{< relref "/navigate/kubernetes/k8s-ingress-controller.md" >}})
2929
- [Verrazzano]({{< relref "/navigate/verrazzano/_index.md" >}})
30+
- [Client Configuration]({{< relref "/navigate/verrazzano/vz-client-config.md" >}})
31+
- [Installation]({{< relref "/navigate/verrazzano/vz-install.md" >}})
32+
- [Component]({{< relref "/navigate/verrazzano/vz-component.md" >}})
33+
- [Application]({{< relref "/navigate/verrazzano/vz-application.md" >}})
3034

3135

3236
At the bottom of the page, the collapsed `Console` panel automatically appears and displays the `stdout` and `stderr`

documentation/staging/1.3/content/navigate/verrazzano/vz-application.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,21 @@ description: "Define and deploy a Verrazzano application."
77
---
88

99
### Contents
10+
- [Verrazzano Application](#verrazzano-application)
1011
- [Design View](#design-view)
1112
- [Components](#components)
1213
- [Code View](#code-view)
1314
- [Deploy Application](#deploy-application)
1415
- [Undeploy Application](#undeploy-application)
1516

1617

18+
### Verrazzano Application
19+
A Verrazzano application is comprised of Components. Components encapsulate application implementation details.
20+
For detailed information, see [Applications](https://verrazzano.io/latest/docs/applications/) in the Verrazzano documentation.
21+
1722
### Design View
18-
`Design View` lets you specify the data used to define the Verrazzano application.
19-
Simply provide values for the following fields:
23+
`Design View` lets you specify the data used to define an Verrazzano application.
24+
Start by providing values for the following fields:
2025

2126
- `Application Name` - The name of the Verrazzano application.
2227
- `Application Namespace` - The Kubernetes namespace to which the application will be deployed.
@@ -30,11 +35,17 @@ Simply provide values for the following fields:
3035
- `Verrazzano Clusters for Application Placement` - The Verrazzano cluster names where the application should be placed. To edit this field, click `Choose Verrazzano Clusters`.
3136

3237
#### Components
38+
You can apply Traits to customize Components for the environment. Traits customize Component workloads and generate related resources during deployment.
3339

40+
Use the `Add Components` button to apply Traits to your application:
41+
- Ingress Trait - provides a simplified integration with the Istio Ingress Gateway included in the Verrazzano platform.
42+
- Manual Scalar - lets you specify the desired replica count.
43+
- Metrics Trait - provides a simplified integration with the Prometheus service included in the Verrazzano platform.
44+
- Logging Trait - contains the configuration for an additional logging sidecar with a custom image and Fluentd configuration file.
3445

3546
### Code View
36-
`Code View` displays shell scripts for installing an ingress controller and for updating ingress routes. It also
37-
displays the YAML definitions of the routes to be added, if applicable.
47+
`Code View` displays a shell script for deploying the Verrazzano application for the WebLogic domain into Kubernetes
48+
as well as the application YAML resource definition and project resource, if applicable.
3849

3950
If it is not already selected, then use the `Script Language` drop-down menu to choose the desired scripting language. Note
4051
that the application is providing a working sample script simply to show how the process might be automated. Before
@@ -45,12 +56,13 @@ the script itself. This change is left as an exercise for you because different
4556
existing standards for securely handling such credentials.
4657

4758
### Deploy Application
48-
`Deploy Application` creates the Domain custom resource object and any of its dependent objects (for example,
49-
namespace, secrets, ConfigMap) in Kubernetes. You access this action by using the `Deploy Domain` button on the
50-
`WebLogic Domain` page or the `Go` > `Deploy WebLogic Domain to Kubernetes` menu item.
59+
`Deploy Application` deploys the application to Verrazzano. You access this action by using the `Deploy Application` button
60+
or the `Go` > `Deploy Verrazzano Application` menu item.
5161

5262
### Undeploy Application
53-
`Undeploy Application` removes the Kubernetes custom resource for the WebLogic domain and its
54-
dependent objects in Kubernetes. In addition, you can choose whether to also delete the corresponding namespace.
55-
You access these actions by using the `Undeploy Domain` button on the
56-
`WebLogic Domain` page or the `Go` > `Undeploy WebLogic Domain to Kubernetes` menu item.
63+
`Undeploy Application` removes the Verrazzano application from the WebLogic domain and its
64+
dependent objects in Kubernetes. Undeploying the application stops the pods associated with the application.
65+
In addition, you can choose whether to also delete the corresponding namespace.
66+
Removing the application namespace removes all applications, components, secrets, ConfigMaps, and other
67+
Kubernetes objects that exist in the Kubernetes namespace. You access these actions by using the `Undeploy Application` button
68+
or the `Go` > `Undeploy Verrazzano Application` menu item.

documentation/staging/1.3/content/navigate/verrazzano/vz-component.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -239,12 +239,15 @@ surfaced here because the `Clusters` pane of the `Design View` is populated only
239239

240240
### Deploy Component
241241
`Deploy Component` creates the domain custom object and any of its dependent objects (for example,
242-
namespace, secrets, ConfigMap) in Kubernetes. You access this action by using the `Deploy Component` button on the
243-
`Component` page or the `Go` > `Deploy Verrazzano Component` menu item.
242+
namespace, secrets, ConfigMap) in Kubernetes. You access this action by using the `Deploy Component` button
243+
or the `Go` > `Deploy Verrazzano Component` menu item.
244244

245245

246246
### Undeploy Component
247247
`Undeploy Component` removes the domain custom object for the WebLogic domain and its
248-
dependent objects in Kubernetes. In addition, you can choose whether to also delete the corresponding namespace.
249-
You access these actions by using the `Undeploy Component` button on the
250-
`Component` page or the `Go` > `Undeploy Verrazzano Component` menu item.
248+
dependent objects in Kubernetes. Undeploying the Verrazzano component will make any Verrazzano applications
249+
referencing these components invalid. In addition, you can choose whether to also delete the corresponding namespace.
250+
Removing the Verrazzano components' namespace removes all applications, components, secrets, ConfigMaps, and other
251+
Kubernetes objects that exist in the Kubernetes namespace.
252+
You access these actions by using the `Undeploy Component` button
253+
or the `Go` > `Undeploy Verrazzano Component` menu item.

documentation/staging/1.3/content/navigate/verrazzano/vz-install.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: "Install Verrazzano"
2+
title: "Installation"
33
date: 2019-02-22T15:44:42-05:00
44
draft: false
55
weight: 2
@@ -27,13 +27,13 @@ provide values for the following fields:
2727

2828
- `Install Name` - The name to give the Verrazzano object during installation.
2929
- `Install Profile` - The Verrazzano installation profile; the choices are: `Dev` (default) and `Production`.
30-
- `Release Version` - Required. Select a Verrazzano release version.
30+
- `Release Version` - Required. Select the desired Verrazzano release version.
3131
- `Install Jaeger` - Optional. Select whether to install the Jaeger transaction tracing component. If selected, then provide
3232
the percentage of Istio requests to be traced in Jaeger in the `Istio Tracing Sampling Rate` field.
3333

3434

3535
### Code View
36-
The `Install Script` displays a shell script that you can use as a starting point for automating the
36+
`Install Script` displays a shell script that you can use as a starting point for automating the
3737
installation of Verrazzano into Kubernetes.
3838

3939
If it is not already selected, then use the `Script Language` drop-down menu to choose the desired scripting language. Note
@@ -44,7 +44,7 @@ set environment variables to specify any credentials required by the script to e
4444
the script itself. This change is left as an exercise for you because different environments typically will have
4545
existing standards for securely handling such credentials.
4646

47-
The `Verrazzano Resource` displays the Verrazzano resource definition that you've specified.
47+
`Verrazzano Resource` displays the Verrazzano resource definition that you've specified.
4848

4949
### Install Verrazzano
5050
`Install Verrazzano` installs Verrazzano in the target Kubernetes cluster.

0 commit comments

Comments
 (0)