Skip to content

Commit 90d19b4

Browse files
committed
edit pass: probes-codepackage
1 parent b0c8875 commit 90d19b4

File tree

1 file changed

+39
-39
lines changed

1 file changed

+39
-39
lines changed

articles/service-fabric/probes-codepackage.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,59 @@
11
---
22
title: Azure Service Fabric probes
3-
description: How to model Liveness Probe in Azure Service Fabric using application and service manifest files.
3+
description: How to model a liveness probe in Azure Service Fabric by using application and service manifest files.
44

55
ms.topic: conceptual
66
ms.date: 3/12/2020
77
---
8-
# Liveness Probe
9-
Starting with 7.1 Service Fabric supports Liveness Probe mechanism for [containerized][containers-introduction-link] applications. Liveness Probe help announce the liveness of the containerized application and when they do not respond in a timely fashion, it will result in a restart.
10-
This article provides an overview of how to define a Liveness Probe via manifest files.
8+
# Liveness probe
9+
Starting with version 7.1, Service Fabric supports a liveness probe mechanism for [containerized][containers-introduction-link] applications. A liveness probe helps to report the liveness of a containerized application, which will restart if it does not respond in a timely fashion.
10+
This article provides an overview of how to define a liveness probe by using manifest files.
1111

12-
Before proceeding with this article, we recommend getting familiar with the [Service Fabric application model][application-model-link] and the [Service Fabric hosting model][hosting-model-link].
12+
Before proceeding with this article, you should become familiar with the [Service Fabric application model][application-model-link] and the [Service Fabric hosting model][hosting-model-link].
1313

1414
> [!NOTE]
15-
> Liveness Probe is only supported for containers on NAT networking mode.
15+
> Liveness probe is only supported for containers on in network address translation mode.
1616
1717
## Semantics
18-
You can specify only 1 Liveness Probe per container and can control it's behavior with these fields:
18+
You can specify only one liveness probe per container and can control its behavior by using these fields:
1919

20-
* `initialDelaySeconds`: The initial delay in seconds to start executing probe once container has started. Supported value is int. Default is 0. Minimum is 0.
20+
* `initialDelaySeconds`: The initial delay in seconds to start executing the probe once the container has started. The supported value is int (default: 0; minimum: 0).
2121

22-
* `timeoutSeconds`: Period in seconds after which we consider probe as failed if it hasn't completed successfully. Supported value is int. Default is 1. Minimum is 1.
22+
* `timeoutSeconds`: The period in seconds after which the probe is considered to have failed, if it hasn't completed successfully. The supported value is int (default: 1; minimum: 1).
2323

24-
* `periodSeconds`: Period in seconds to specify how often we probe. Supported value is int. Default is 10. Minimum is 1.
24+
* `periodSeconds`: The period in seconds to specify the frequency of the probe. The supported value is int (default: 10; minimum: 1).
2525

26-
* `failureThreshold`: Once we hit FailureThreshold, container will restart. Supported value is int. Default is 3. Minimum is 1.
26+
* `failureThreshold`: When this value is reached the container will restart. The supported value is int (default: 3; minimum: 1).
2727

28-
* `successThreshold`: On failure, for probe to be considered success it has to execute successfully for SuccessThreshold. Supported value is int. Default is 1. Minimum is 1.
28+
* `successThreshold`: On failure, for the probe to be considered successful, it has to execute successfully for this value. The supported value is int (default: 1; minimum: 1).
2929

30-
There will be at most 1 probe to container at one moment of time. If the probe does not complete in **timeoutSeconds** we keep waiting and counting it towards the **failureThreshold**.
30+
There can be, at most, one probe to one container at any moment in time. If the probe does not complete in the time set in **timeoutSeconds**, wait and count the time towards the **failureThreshold**.
3131

32-
Additionally, ServiceFabric will raise following probe [Health Reports][health-introduction-link] on DeployedServicePackage:
32+
Additionally, Service Fabric will raise the following probe [Health Reports][health-introduction-link] on **DeployedServicePackage**:
3333

34-
* `Ok`: If the probe succeeds for **successThreshold** then we report health as Ok.
34+
* `OK`: The probe succeeds for the value set in **successThreshold**.
3535

36-
* `Error`: If the probe failureCount == **failureThreshold**, before restarting the container we report Error.
36+
* `Error`: The probe **failureCount** == **failureThreshold**, before the container restarts.
3737

3838
* `Warning`:
39-
1. If the probe fails and the failureCount < **failureThreshold** we report Warning. This health report stays until failureCount reaches **failureThreshold** or **successThreshold**.
40-
2. On success post failure, we still report Warning but with updated consecutive success.
39+
* The probe fails and **failureCount** < **failureThreshold**. This health report stays until **failureCount** reaches the value set in **failureThreshold** or **successThreshold**.
40+
* On success post failure, the warning remains but with updated consecutive successes.
4141

42-
## Specifying Liveness Probe
42+
## Specifying a liveness probe
4343

44-
You can specify probe in the ApplicationManifest.xml under ServiceManifestImport:
44+
You can specify a probe in the ApplicationManifest.xml file under **ServiceManifestImport**:
4545

46-
Probe can either one of :
46+
The probe can be for any of the following:
4747

48-
1. HTTP
49-
2. TCP
50-
3. Exec
48+
* HTTP
49+
* TCP
50+
* Exec
5151

52-
## HTTP Probe
52+
### HTTP probe
5353

54-
For HTTP probe, Service Fabric will send an HTTP request to the port and path specified. Return code greater than or equal to 200 and less than 400 indicates success.
54+
For an HTTP probe, Service Fabric will send an HTTP request to the port and path that you specify. A return code that is greater than, or equal to, 200 and less than 400 indicates success.
5555

56-
Here is an example of how to specify HttpGet probe:
56+
Here is an example of how to specify an HTTP probe:
5757

5858
```xml
5959
<ServiceManifestImport>
@@ -74,21 +74,21 @@ Here is an example of how to specify HttpGet probe:
7474
</ServiceManifestImport>
7575
```
7676

77-
HttpGet probe has additional properties you can set:
77+
The HTTP probe has additional properties you can set as follows:
7878

79-
* `path`: Path to access on the HTTP request.
79+
* `path`: The path to use in the HTTP request.
8080

81-
* `port`: Port to access for probes. Range is 1 to 65535. Mandatory.
81+
* `port`: The port to use for probes. The range is 1 to 65535 (mandatory).
8282

83-
* `scheme`: Scheme to use for connecting to code package. If set to HTTPS, certificate verification is skipped. Defaults to HTTP
83+
* `scheme`: The scheme to use for connecting to the code package. If this is set to HTTPS, the certificate verification is skipped. The default setting is HTTP.
8484

85-
* `httpHeader`: Headers to set in the request. You can specify multiple of these.
85+
* `httpHeader`: The headers to set in the request. You can specify multiple headers.
8686

87-
* `host`: Host IP to connect to.
87+
* `host`: The host IP address to connect to.
8888

89-
## TCP Probe
89+
### TCP probe
9090

91-
For TCP probe, Service Fabric will try to open a socket on the container with the specified port. If it can establish a connection, the probe is considered success. Here is an example of how to specify probe which uses TCP socket:
91+
For a TCP probe, Service Fabric will try to open a socket on the container by using the specified port. If it can establish a connection, the probe is considered successful. Here is an example of how to specify a probe that uses a TCP socket:
9292

9393
```xml
9494
<ServiceManifestImport>
@@ -106,13 +106,13 @@ For TCP probe, Service Fabric will try to open a socket on the container with th
106106
</ServiceManifestImport>
107107
```
108108

109-
## Exec Probe
109+
### Exec probe
110110

111-
This probe will issue an exec into the container and wait for the command to complete.
111+
This probe will issue an **exec** command into the container and wait for the command to complete.
112112

113113
> [!NOTE]
114-
> Exec command takes a comma seperated string. The following command in the example will work for Linux container.
115-
> If you are trying windows container, use <Command>cmd</Command>
114+
> **Exec** command takes a comma separated string. The command in the following example will work for a Linux container.
115+
> If you are trying to probe a Windows container, use **cmd**.
116116
117117
```xml
118118
<ServiceManifestImport>

0 commit comments

Comments
 (0)