feature: support for /project endpoint (getKubeconfig) (#3)

Author: tomasroy-ibm

modules/examples/README.md

@@ -23,11 +23,38 @@ IbmCloudCodeEngine ceClient = new IbmCloudCodeEngine("Code Engine Client", authe
 ceClient.setServiceUrl("https://api." + System.getenv("CE_PROJECT_REGION") + ".codeengine.cloud.ibm.com/api/v1");
 ```
 
+### Get a Delegated Refresh Token from IAM using an HTTP client
+This example uses Java's `HttpURLConnection`, but you may use the HTTP client of your choice.
+```java
+URL iamUrl = new URL("https://iam.cloud.ibm.com/identity/token?"
+  + "grant_type=urn:ibm:params:oauth:grant-type:apikey&"
+  + "response_type=delegated_refresh_token&"
+  + "receiver_client_ids=ce&"
+  + "delegated_refresh_token_expiry=3600&"
+  + "apikey="
+  + System.getenv("CE_API_KEY"));
+HttpURLConnection iamConnection = (HttpURLConnection) iamUrl.openConnection();
+iamConnection.setRequestMethod("POST");
+iamConnection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
+BufferedReader iamInput = new BufferedReader(new InputStreamReader(iamConnection.getInputStream()));
+String iamResponse = "";
+String iamInputLine = "";
+while ((iamInputLine = iamInput.readLine()) != null) {
+  iamResponse = iamResponse + iamInputLine;
+}
+iamInput.close();
+JSONObject iamJson = new JSONObject(iamResponse);
+String delegatedRefreshToken = iamJson.getString("delegated_refresh_token");
+```
+
 ### Use the Code Engine client to get a Kubernetes config
 ```java
-ListKubeconfigOptions options = new ListKubeconfigOptions.Builder()
+GetKubeconfigOptions options = new GetKubeconfigOptions.Builder()
   .id(ceProjectID)
-  .refreshToken(authenticator.requestToken().getRefreshToken())
+  .xDelegatedRefreshToken(authenticator.requestToken().getRefreshToken())
   .build();
-Response<String> kubeConfigResponse = ceClient.listKubeconfig(options).execute();
-```
+Response<String> kubeConfigResponse = ceClient.getKubeconfig(options).execute();
+```
+
+## Deprecated endpoint
+The `/namespaces/{id}/config` endpoint function, `listKubeconfig()`, is deprecated, and will be removed before Code Engine is out of Beta. Please use the `getKubeconfig()` function, demonstrated in the example above.

modules/examples/pom.xml

@@ -29,6 +29,11 @@
             <artifactId>client-java</artifactId>
             <version>9.0.0</version>
         </dependency>
+        <dependency>
+            <groupId>org.json</groupId>
+            <artifactId>json</artifactId>
+            <version>20180130</version>
+        </dependency>
     </dependencies>
 
     <properties>

modules/examples/src/main/java/com/ibm/cloud/code_engine/ibm_cloud_code_engine/v1/IbmCloudCodeEngineExamples.java

@@ -13,12 +13,18 @@
 
 package com.ibm.cloud.code_engine.ibm_cloud_code_engine.v1;
 
-import com.ibm.cloud.code_engine.ibm_cloud_code_engine.v1.model.ListKubeconfigOptions;
+import com.ibm.cloud.code_engine.ibm_cloud_code_engine.v1.model.GetKubeconfigOptions;
 import com.ibm.cloud.sdk.core.security.IamAuthenticator;
 import com.ibm.cloud.sdk.core.http.Response;
 
 import java.io.Reader;
 import java.io.StringReader;
+import java.net.HttpURLConnection;
+import java.net.URL;
+import java.io.BufferedReader;
+import java.io.InputStreamReader;
+
+import org.json.JSONObject;
 import io.kubernetes.client.util.KubeConfig;
 import io.kubernetes.client.openapi.ApiClient;
 import io.kubernetes.client.util.Config;
@@ -43,15 +49,33 @@ public static void main(String[] args) throws Exception {
     IbmCloudCodeEngine ceClient = new IbmCloudCodeEngine("Code Engine Client", authenticator);
     ceClient.setServiceUrl("https://api." + System.getenv("CE_PROJECT_REGION") + ".codeengine.cloud.ibm.com/api/v1");
 
-    // Get an IAM refresh token using the authenticator.
-    String refreshToken = authenticator.requestToken().getRefreshToken();
+    // Get an IAM delegated refresh token using an HTTP client
+    URL iamUrl = new URL("https://iam.cloud.ibm.com/identity/token?"
+      + "grant_type=urn:ibm:params:oauth:grant-type:apikey&"
+      + "response_type=delegated_refresh_token&"
+      + "receiver_client_ids=ce&"
+      + "delegated_refresh_token_expiry=3600&"
+      + "apikey="
+      + System.getenv("CE_API_KEY"));
+    HttpURLConnection iamConnection = (HttpURLConnection) iamUrl.openConnection();
+    iamConnection.setRequestMethod("POST");
+    iamConnection.setRequestProperty("Content-Type", "application/x-www-form-urlencoded");
+    BufferedReader iamInput = new BufferedReader(new InputStreamReader(iamConnection.getInputStream()));
+    String iamResponse = "";
+    String iamInputLine = "";
+    while ((iamInputLine = iamInput.readLine()) != null) {
+      iamResponse = iamResponse + iamInputLine;
+    }
+    iamInput.close();
+    JSONObject iamJson = new JSONObject(iamResponse);
+    String delegatedRefreshToken = iamJson.getString("delegated_refresh_token");
 
     // Get Code Egnine project config using the Code Engine Client
-    ListKubeconfigOptions options = new ListKubeconfigOptions.Builder()
+    GetKubeconfigOptions options = new GetKubeconfigOptions.Builder()
       .id(System.getenv("CE_PROJECT_ID"))
-      .refreshToken(refreshToken)
+      .xDelegatedRefreshToken(delegatedRefreshToken)
       .build();
-    Response<String> kubeConfigResponse = ceClient.listKubeconfig(options).execute();
+    Response<String> kubeConfigResponse = ceClient.getKubeconfig(options).execute();
 
     // Setup Kubernetes client using the project config
     String kubeConfigString = kubeConfigResponse.getResult();

modules/examples/src/main/java/com/ibm/cloud/code_engine/ibm_cloud_code_engine/v1/IbmCloudCodeEngineExamplesDeprecated.java

@@ -0,0 +1,68 @@
+/*
+ * (C) Copyright IBM Corp. 2020.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+
+package com.ibm.cloud.code_engine.ibm_cloud_code_engine.v1;
+
+import com.ibm.cloud.code_engine.ibm_cloud_code_engine.v1.model.ListKubeconfigOptions;
+import com.ibm.cloud.sdk.core.security.IamAuthenticator;
+import com.ibm.cloud.sdk.core.http.Response;
+
+import java.io.Reader;
+import java.io.StringReader;
+import io.kubernetes.client.util.KubeConfig;
+import io.kubernetes.client.openapi.ApiClient;
+import io.kubernetes.client.util.Config;
+import io.kubernetes.client.openapi.Configuration;
+import io.kubernetes.client.openapi.apis.CoreV1Api;
+import io.kubernetes.client.openapi.models.V1ConfigMapList;
+
+public class IbmCloudCodeEngineExamplesDeprecated {
+
+  // Suppress utility class error by making private constructor
+  private IbmCloudCodeEngineExamplesDeprecated() {
+    throw new IllegalStateException("Just an example");
+  }
+
+  public static void main(String[] args) throws Exception {
+
+    // Create an IAM authenticator.
+    IamAuthenticator authenticator = new IamAuthenticator(System.getenv("CE_API_KEY"));
+    authenticator.setClientIdAndSecret("bx", "bx");
+
+    // Construct the Code Engine Client
+    IbmCloudCodeEngine ceClient = new IbmCloudCodeEngine("Code Engine Client", authenticator);
+    ceClient.setServiceUrl("https://api." + System.getenv("CE_PROJECT_REGION") + ".codeengine.cloud.ibm.com/api/v1");
+
+    // Get an IAM refresh token using the authenticator.
+    String refreshToken = authenticator.requestToken().getRefreshToken();
+
+    // Get Code Egnine project config using the Code Engine Client
+    ListKubeconfigOptions options = new ListKubeconfigOptions.Builder()
+      .id(System.getenv("CE_PROJECT_ID"))
+      .refreshToken(refreshToken)
+      .build();
+    Response<String> kubeConfigResponse = ceClient.listKubeconfig(options).execute();
+
+    // Setup Kubernetes client using the project config
+    String kubeConfigString = kubeConfigResponse.getResult();
+    Reader kubeConfigReader = new StringReader(kubeConfigString);
+    KubeConfig config = KubeConfig.loadKubeConfig(kubeConfigReader);
+    ApiClient client = Config.fromConfig(config);
+    Configuration.setDefaultApiClient(client);
+
+    // Get something from project.
+    CoreV1Api api = new CoreV1Api();
+    V1ConfigMapList configMapList = api.listNamespacedConfigMap(config.getNamespace(), null, null, null, null, null, null, null, null, null);
+    System.out.printf("Project %s has %d configmaps.", System.getenv("CE_PROJECT_ID"), configMapList.getItems().size());
+  }
+}

modules/ibm-cloud-code-engine/src/main/java/com/ibm/cloud/code_engine/ibm_cloud_code_engine/v1/IbmCloudCodeEngine.java

@@ -1,5 +1,5 @@
 /*
- * (C) Copyright IBM Corp. 2020.
+ * (C) Copyright IBM Corp. 2021.
  *
  * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
  * the License. You may obtain a copy of the License at
@@ -18,6 +18,7 @@
 package com.ibm.cloud.code_engine.ibm_cloud_code_engine.v1;
 
 import com.ibm.cloud.code_engine.common.SdkCommon;
+import com.ibm.cloud.code_engine.ibm_cloud_code_engine.v1.model.GetKubeconfigOptions;
 import com.ibm.cloud.code_engine.ibm_cloud_code_engine.v1.model.ListKubeconfigOptions;
 import com.ibm.cloud.sdk.core.http.RequestBuilder;
 import com.ibm.cloud.sdk.core.http.ResponseConverter;
@@ -31,7 +32,7 @@
 import java.util.Map.Entry;
 
 /**
- * The purpose is to provide an API to get Kubeconfig for IBM Cloud Code Engine Project.
+ * The purpose is to provide an API to get Kubeconfig file for IBM Cloud Code Engine Project.
  *
  * @version v1
  */
@@ -78,9 +79,10 @@ public IbmCloudCodeEngine(String serviceName, Authenticator authenticator) {
   }
 
   /**
-   * Retrieve KUBECONFIG for a specified project.
+   * Deprecated soon: Retrieve KUBECONFIG for a specified project.
    *
-   * Returns the KUBECONFIG, similar to the output of `kubectl config view --minify=true`.
+   * **Deprecated soon**: This API will be deprecated soon. Use the [GET /project/{id}/config](#get-kubeconfig) API
+   * instead. Returns the KUBECONFIG file, similar to the output of `kubectl config view --minify=true`.
    *
    * @param listKubeconfigOptions the {@link ListKubeconfigOptions} containing the options for the call
    * @return a {@link ServiceCall} with a result of type {@link String}
@@ -95,8 +97,51 @@ public ServiceCall<String> listKubeconfig(ListKubeconfigOptions listKubeconfigOp
     for (Entry<String, String> header : sdkHeaders.entrySet()) {
       builder.header(header.getKey(), header.getValue());
     }
-    builder.header("Accept", "text/plain");
     builder.header("Refresh-Token", listKubeconfigOptions.refreshToken());
+    if (listKubeconfigOptions.accept() != null) {
+      builder.header("Accept", listKubeconfigOptions.accept());
+    }
+    ResponseConverter<String> responseConverter = ResponseConverterUtils.getString();
+    return createServiceCall(builder.build(), responseConverter);
+  }
+
+  /**
+   * Retrieve KUBECONFIG for a specified project.
+   *
+   * Returns the KUBECONFIG, similar to the output of `kubectl config view --minify=true`. There are 2 tokens in the
+   * Request Header and a query parameter that you must provide.
+   *  These values can be generated as follows: 1. Auth Header Pass the generated IAM Token as the Authorization header
+   * from the CLI as `token=cat $HOME/.bluemix/config.json | jq .IAMToken -r`. Generate the token with the [Create an
+   * IAM access token for a user or service ID using an API
+   * key](https://cloud.ibm.com/apidocs/iam-identity-token-api#gettoken-apikey) API.
+   *
+   * 2. X-Delegated-Refresh-Token Header Generate an IAM Delegated Refresh Token for Code Engine with the [Create an IAM
+   * access token and delegated refresh token for a user or service
+   * ID](https://cloud.ibm.com/apidocs/iam-identity-token-api#gettoken-apikey-delegatedrefreshtoken) API. Specify the
+   * `receiver_client_ids` value to be `ce` and the `delegated_refresh_token_expiry` value to be `3600`.
+   *
+   * 3. Project ID In order to retrieve the Kubeconfig file for a specific Code Engine project, use the CLI to extract
+   * the ID
+   * `id=ibmcloud ce project get -n ${CE_PROJECT_NAME} -o jsonpath={.guid}` You must be logged into the account where
+   * the project was created to retrieve the ID.
+   *
+   * @param getKubeconfigOptions the {@link GetKubeconfigOptions} containing the options for the call
+   * @return a {@link ServiceCall} with a result of type {@link String}
+   */
+  public ServiceCall<String> getKubeconfig(GetKubeconfigOptions getKubeconfigOptions) {
+    com.ibm.cloud.sdk.core.util.Validator.notNull(getKubeconfigOptions,
+      "getKubeconfigOptions cannot be null");
+    Map<String, String> pathParamsMap = new HashMap<String, String>();
+    pathParamsMap.put("id", getKubeconfigOptions.id());
+    RequestBuilder builder = RequestBuilder.get(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/project/{id}/config", pathParamsMap));
+    Map<String, String> sdkHeaders = SdkCommon.getSdkHeaders("ibm_cloud_code_engine", "v1", "getKubeconfig");
+    for (Entry<String, String> header : sdkHeaders.entrySet()) {
+      builder.header(header.getKey(), header.getValue());
+    }
+    builder.header("X-Delegated-Refresh-Token", getKubeconfigOptions.xDelegatedRefreshToken());
+    if (getKubeconfigOptions.accept() != null) {
+      builder.header("Accept", getKubeconfigOptions.accept());
+    }
     ResponseConverter<String> responseConverter = ResponseConverterUtils.getString();
     return createServiceCall(builder.build(), responseConverter);
   }