Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update url placeholder values #856

Merged
merged 1 commit into from
Feb 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/developer-guides/using-workers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ Run the annotated Java worker using WorkflowExecutor.

``` java
var client = ApiClient.builder()
.basePath("https://developer.orkescloud.com/api")
.basePath("https://SERVER_URL/api") // e.g., "https://developer.orkescloud.com/api"
.credentials("_CHANGE_ME_", "_CHANGE_ME_")
.build();
int pollingInterval = 50;
Expand All @@ -285,7 +285,7 @@ import {
} from "@io-orkes/conductor-javascript";

const config = {
serverUrl: "https://developer.orkescloud.com/api",
serverUrl: "https://SERVER_URL/api", // e.g., "https://developer.orkescloud.com/api"
keyId: "_CHANGE_ME_",
keySecret: "_CHANGE_ME_",
};
Expand All @@ -302,7 +302,7 @@ manager.startPolling();
``` csharp
var conf = new Configuration
{
BasePath = "https://developer.orkescloud.com/api",
BasePath = "https://SERVER_URL/api", // e.g., "https://developer.orkescloud.com/api"
AuthenticationSettings = new OrkesAuthenticationSettings("_CHANGE_ME_", "_CHANGE_ME_")
};

Expand Down Expand Up @@ -334,7 +334,7 @@ apiClient := client.NewAPIClient(
SECRET,
),
settings.NewHttpSettings(
"https://developer.orkescloud.com/api",
"https://SERVER_URL/api", // e.g., "https://developer.orkescloud.com/api"
))

taskRunner = worker.NewTaskRunnerWithApiClient(apiClient)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ class WorkflowMigration

private static Configuration configuration = new Configuration()
{
BasePath = "conductor_url",
BasePath = "https://SERVER_URL/api", // e.g., "https://developer.orkescloud.com/api" for Developer Edition
AuthenticationSettings = new OrkesAuthenticationSettings("keyId", "keySecret")
};

Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/csharp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Use Conductor to create applications in C#."

Orkes Conductor C# SDK is maintained here: https://github.com/conductor-sdk/conductor-csharp

## Setup Conductor C# Package
## Set up Conductor C# Package

```shell
dotnet add package conductor-csharp
Expand All @@ -23,7 +23,7 @@ using Conductor.Client;
using Conductor.Client.Authentication;

var configuration = new Configuration() {
BasePath = basePath,
BasePath = "https://SERVER_URL/api" , // e.g., "https://developer.orkescloud.com/api" for Developer Edition
AuthenticationSettings = null
};

Expand All @@ -42,7 +42,7 @@ using Conductor.Client;
using Conductor.Client.Authentication;

var configuration = new Configuration() {
BasePath = basePath,
BasePath = "https://SERVER_URL/api" , // e.g., "https://developer.orkescloud.com/api" for Developer Edition
AuthenticationSettings = new OrkesAuthenticationSettings("keyId", "keySecret")
};

Expand Down
4 changes: 2 additions & 2 deletions docs/sdks/golang.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Everything related to server settings should be done within the `client.NewAPICl
apiClient := client.NewAPIClient(
nil,
settings.NewHttpSettings(
"https://developer.orkescloud.com",
"https://SERVER_URL/api", // e.g., "https://developer.orkescloud.com/api"
),
)

Expand All @@ -42,7 +42,7 @@ Once we have a key and secret, we can configure the app from properties or envir
SECRET,
),
settings.NewHttpSettings(
"https://developer.orkescloud.com",
"https://SERVER_URL/api", // e.g., "https://developer.orkescloud.com/api"
),
)

Expand Down
10 changes: 5 additions & 5 deletions docs/sdks/java.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ import java.util.concurrent.TimeoutException;
public class Main {

// Change these values according to your conductor server instance. Refer to the documentation on creating an access key - https://orkes.io/content/sdks/authentication#retrieving-access-keys.
private static final String CONDUCTOR_SERVER = "https://play.orkes.io/api";
private static final String CONDUCTOR_SERVER = "https://developer.orkescloud.com/api";
private static final String KEY = "_CHANGE_ME_";
private static final String SECRET = "_CHANGE_ME_";

Expand Down Expand Up @@ -238,7 +238,7 @@ import java.util.concurrent.TimeoutException;
public class Main {

// Change these values according to your conductor server instance. Refer to the documentation on creating an access key - https://orkes.io/content/sdks/authentication#retrieving-access-keys.
private static final String CONDUCTOR_SERVER = "https://play.orkes.io/api";
private static final String CONDUCTOR_SERVER = "https://SERVER_URL/api"; // e.g., https://developer.orkescloud.com/api
private static final String KEY = "_CHANGE_ME_";
private static final String SECRET = "_CHANGE_ME_";

Expand Down Expand Up @@ -278,7 +278,7 @@ public class Main {
Everything related to server settings should be done within the `ApiClient` class by setting the required parameters when initializing an object, like this:

```shell
ApiClient apiClient = new ApiClient("CONDUCTOR_SERVER_URL");
ApiClient apiClient = new ApiClient("https://SERVER_URL/api"); // e.g., "https://developer.orkescloud.com/api" for Developer Edition
```

If you are using Spring Framework, you can initialize the above class as a bean that can be used across the project.
Expand Down Expand Up @@ -346,7 +346,7 @@ public class ConductorWorkers {
Workers use a polling mechanism (with a long poll) to periodically check for available tasks from the server. The startup and shutdown of workers are handled by the `conductor.client.automator.TaskRunnerConfigurer` class.

```java
WorkflowExecutor executor = new WorkflowExecutor("http://server/api/");
WorkflowExecutor executor = new WorkflowExecutor("https://SERVER_URL/api";); // e.g., https://developer.orkescloud.com/api
/*List of packages (comma separated) to scan for annotated workers.
Please note the worker method MUST be public, and the class in which they are defined
MUST have a no-args constructor*/
Expand Down Expand Up @@ -967,4 +967,4 @@ A powerful feature of Conductor is the ability to version workflows. You should
- Versioning allows safely testing changes by doing canary testing in production or A/B testing across multiple versions before rolling out.
- A version can also be deleted, effectively allowing for "rollback" if required.

Check out more [examples](https://github.com/orkes-io/orkes-conductor-client/tree/main/examples).
Check out more [examples](https://github.com/orkes-io/orkes-conductor-client/tree/main/examples).
7 changes: 3 additions & 4 deletions docs/sdks/javascript.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ npm install --save @io-orkes/conductor-javascript
} from "@io-orkes/conductor-javascript";

export const config = {
serverUrl: `${process.env.SERVER_URL}`,
serverUrl: `${process.env.SERVER_URL}`, // e.g., "https://developer.orkescloud.com/api" for Developer Edition
};

(async () => {
Expand All @@ -51,7 +51,7 @@ Once we have a key and secret, we can configure the app from properties or envir
export const config = {
keyId: process.env.KEY,
keySecret:process.env.SECRET,
serverUrl: `${process.env.SERVER_URL}`,
serverUrl: `${process.env.SERVER_URL}`, // e.g., "https://developer.orkescloud.com/api" for Developer Edition
};

(async () => {
Expand All @@ -67,5 +67,4 @@ Remember to protect your app secrets like any other secrets or passwords.

- Video Guide on [Getting Access Key and Secret](/developer-guides/running-workflows#run-in-ui)
- [Access Control & Security](/content/category/access-control-and-security)
- [NextJS Example](https://github.com/orkes-io/conductor-nextjs-example/tree/main)

- [NextJS Example](https://github.com/orkes-io/conductor-nextjs-example/tree/main)
4 changes: 2 additions & 2 deletions docs/sdks/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -228,7 +228,7 @@ For running the workflow in Orkes Conductor,
- Update the Conductor server URL to your cluster name.

```shell
export CONDUCTOR_SERVER_URL=https://[cluster-name].orkesconductor.io/api
export CONDUCTOR_SERVER_URL=https://SERVER_URL/api
```

- If you want to run the workflow on the Orkes Developer Edition, set the Conductor Server variable as follows:
Expand Down Expand Up @@ -532,7 +532,7 @@ def send_email(email: str, subject: str, body: str):
def main():

# defaults to reading the configuration using following env variables
# CONDUCTOR_SERVER_URL : conductor server e.g. https://developer.orkescloud.com/api
# CONDUCTOR_SERVER_URL : https://SERVER_URL/api // e.g., https://developer.orkescloud.com/api
# CONDUCTOR_AUTH_KEY : API Authentication Key
# CONDUCTOR_AUTH_SECRET: API Auth Secret
api_config = Configuration()
Expand Down