Skip to content

Commit

Permalink
add missing descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@sean1588
sean1588 committed Apr 18, 2024
1 parent e74a03d commit 347ae04
Show file tree
Hide file tree
Showing 10 changed files with 323 additions and 59 deletions.
28 changes: 21 additions & 7 deletions provider/cmd/pulumi-gen-eks/main.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,8 @@ func generateSchema() schema.PackageSpec {
Outputs: &schema.ObjectTypeSpec{
Properties: map[string]schema.PropertySpec{
"result": {
TypeSpec: schema.TypeSpec{Type: "string"},
TypeSpec: schema.TypeSpec{Type: "string"},
Description: "The kubeconfig for the cluster.",
},
},
Required: []string{"result"},
Expand Down Expand Up @@ -972,16 +973,19 @@ func generateSchema() schema.PackageSpec {
TypeSpec: schema.TypeSpec{Ref: awsRef("#/resources/aws:eks%2Fcluster:Cluster")},
},
"vpcId": {
TypeSpec: schema.TypeSpec{Type: "string"},
TypeSpec: schema.TypeSpec{Type: "string"},
Description: "ID of the cluster's VPC.",
},
"subnetIds": {
TypeSpec: schema.TypeSpec{
Type: "array",
Items: &schema.TypeSpec{Type: "string"},
},
Description: "List of subnet IDs for the EKS cluster.",
},
"endpoint": {
TypeSpec: schema.TypeSpec{Type: "string"},
TypeSpec: schema.TypeSpec{Type: "string"},
Description: "The EKS cluster's Kubernetes API server endpoint.",
},
"clusterSecurityGroup": {
TypeSpec: schema.TypeSpec{Ref: awsRef("#/resources/aws:ec2%2FsecurityGroup:SecurityGroup")},
Expand All @@ -994,9 +998,11 @@ func generateSchema() schema.PackageSpec {
Type: "array",
Items: &schema.TypeSpec{Ref: awsRef("#/resources/aws:iam%2Frole:Role")},
},
Description: "The IAM instance roles for the cluster's nodes.",
},
"nodeGroupOptions": {
TypeSpec: schema.TypeSpec{Ref: "#/types/eks:index:ClusterNodeGroupOptions"},
TypeSpec: schema.TypeSpec{Ref: "#/types/eks:index:ClusterNodeGroupOptions"},
Description: "The cluster's node group options.",
},
"awsProvider": {
TypeSpec: schema.TypeSpec{Ref: awsRef("#/provider")},
Expand All @@ -1006,12 +1012,14 @@ func generateSchema() schema.PackageSpec {
Type: "array",
Items: &schema.TypeSpec{Type: "string"},
},
Description: "List of subnet IDs for the public subnets.",
},
"privateSubnetIds": {
TypeSpec: schema.TypeSpec{
Type: "array",
Items: &schema.TypeSpec{Type: "string"},
},
Description: "List of subnet IDs for the private subnets.",
},
"eksNodeAccess": {
TypeSpec: schema.TypeSpec{Ref: k8sRef("#/resources/kubernetes:core%2Fv1:ConfigMap")},
Expand All @@ -1021,27 +1029,33 @@ func generateSchema() schema.PackageSpec {
Type: "object",
AdditionalProperties: &schema.TypeSpec{Ref: k8sRef("#/resources/kubernetes:storage.k8s.io%2Fv1:StorageClass")},
},
Description: "The storage class used for persistent storage by the cluster.",
},
"kubeconfig": {
TypeSpec: schema.TypeSpec{Ref: "pulumi.json#/Any"},
TypeSpec: schema.TypeSpec{Ref: "pulumi.json#/Any"},
Description: "The kubeconfig file for the cluster.",
},
"vpcCni": {
TypeSpec: schema.TypeSpec{Ref: "#/resources/eks:index:VpcCni"},
TypeSpec: schema.TypeSpec{Ref: "#/resources/eks:index:VpcCni"},
Description: "The VPC CNI for the cluster.",
},
"tags": {
TypeSpec: schema.TypeSpec{
Type: "object",
AdditionalProperties: &schema.TypeSpec{Type: "string"},
},
Description: "A map of tags assigned to the EKS cluster.",
},
"nodeSecurityGroupTags": {
TypeSpec: schema.TypeSpec{
Type: "object",
AdditionalProperties: &schema.TypeSpec{Type: "string"},
},
Description: "Tags attached to the security groups associated with the cluster's worker nodes.",
},
"fargateProfile": {
TypeSpec: schema.TypeSpec{Ref: awsRef("#/resources/aws:eks%2FfargateProfile:FargateProfile")},
TypeSpec: schema.TypeSpec{Ref: awsRef("#/resources/aws:eks%2FfargateProfile:FargateProfile")},
Description: "The Fargate profile used to manage which pods run on Fargate.",
},
"oidcProvider": {
TypeSpec: schema.TypeSpec{Ref: awsRef("#/resources/aws:iam%2FopenIdConnectProvider:OpenIdConnectProvider")},
Expand Down
42 changes: 28 additions & 14 deletions provider/cmd/pulumi-resource-eks/schema.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -209,28 +209,34 @@
"$ref": "/aws/v6.5.0/schema.json#/types/aws:eks%2FClusterEncryptionConfig:ClusterEncryptionConfig"
},
"endpoint": {
"type": "string"
"type": "string",
"description": "The EKS cluster's Kubernetes API server endpoint."
},
"fargateProfile": {
"$ref": "/aws/v6.5.0/schema.json#/resources/aws:eks%2FfargateProfile:FargateProfile"
"$ref": "/aws/v6.5.0/schema.json#/resources/aws:eks%2FfargateProfile:FargateProfile",
"description": "The Fargate profile used to manage which pods run on Fargate."
},
"instanceRoles": {
"type": "array",
"items": {
"$ref": "/aws/v6.5.0/schema.json#/resources/aws:iam%2Frole:Role"
}
},
"description": "The IAM instance roles for the cluster's nodes."
},
"kubeconfig": {
"$ref": "pulumi.json#/Any"
"$ref": "pulumi.json#/Any",
"description": "The kubeconfig file for the cluster."
},
"nodeGroupOptions": {
"$ref": "#/types/eks:index:ClusterNodeGroupOptions"
"$ref": "#/types/eks:index:ClusterNodeGroupOptions",
"description": "The cluster's node group options."
},
"nodeSecurityGroupTags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"description": "Tags attached to the security groups associated with the cluster's worker nodes."
},
"oidcProvider": {
"$ref": "/aws/v6.5.0/schema.json#/resources/aws:iam%2FopenIdConnectProvider:OpenIdConnectProvider"
Expand All @@ -239,7 +245,8 @@
"type": "array",
"items": {
"type": "string"
}
},
"description": "List of subnet IDs for the private subnets."
},
"provider": {
"$ref": "/kubernetes/v4.4.0/schema.json#/provider"
Expand All @@ -248,31 +255,37 @@
"type": "array",
"items": {
"type": "string"
}
},
"description": "List of subnet IDs for the public subnets."
},
"storageClasses": {
"type": "object",
"additionalProperties": {
"$ref": "/kubernetes/v4.4.0/schema.json#/resources/kubernetes:storage.k8s.io%2Fv1:StorageClass"
}
},
"description": "The storage class used for persistent storage by the cluster."
},
"subnetIds": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "List of subnet IDs for the EKS cluster."
},
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"description": "A map of tags assigned to the EKS cluster."
},
"vpcCni": {
"$ref": "#/resources/eks:index:VpcCni"
"$ref": "#/resources/eks:index:VpcCni",
"description": "The VPC CNI for the cluster."
},
"vpcId": {
"type": "string"
"type": "string",
"description": "ID of the cluster's VPC."
}
},
"type": "object",
Expand Down Expand Up @@ -1607,7 +1620,8 @@
"outputs": {
"properties": {
"result": {
"type": "string"
"type": "string",
"description": "The kubeconfig for the cluster."
}
},
"required": [
Expand Down
3 changes: 3 additions & 0 deletions sdk/dotnet/Cluster.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -671,6 +671,9 @@ public ClusterGetKubeconfigArgs()
[OutputType]
internal sealed class ClusterGetKubeconfigResult
{
/// <summary>
/// The kubeconfig for the cluster.
/// </summary>
public readonly string Result;

[OutputConstructor]
Expand Down
46 changes: 46 additions & 0 deletions sdk/dotnet/Inputs/CoreDataArgs.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,28 +36,48 @@ public sealed class CoreDataArgs : global::Pulumi.ResourceArgs
[Input("encryptionConfig")]
public Input<Pulumi.Aws.Eks.Inputs.ClusterEncryptionConfigArgs>? EncryptionConfig { get; set; }

/// <summary>
/// The EKS cluster's Kubernetes API server endpoint.
/// </summary>
[Input("endpoint", required: true)]
public Input<string> Endpoint { get; set; } = null!;

/// <summary>
/// The Fargate profile used to manage which pods run on Fargate.
/// </summary>
[Input("fargateProfile")]
public Input<Pulumi.Aws.Eks.FargateProfile>? FargateProfile { get; set; }

[Input("instanceRoles", required: true)]
private InputList<Pulumi.Aws.Iam.Role>? _instanceRoles;

/// <summary>
/// The IAM instance roles for the cluster's nodes.
/// </summary>
public InputList<Pulumi.Aws.Iam.Role> InstanceRoles
{
get => _instanceRoles ?? (_instanceRoles = new InputList<Pulumi.Aws.Iam.Role>());
set => _instanceRoles = value;
}

/// <summary>
/// The kubeconfig file for the cluster.
/// </summary>
[Input("kubeconfig")]
public Input<object>? Kubeconfig { get; set; }

/// <summary>
/// The cluster's node group options.
/// </summary>
[Input("nodeGroupOptions", required: true)]
public Input<Inputs.ClusterNodeGroupOptionsArgs> NodeGroupOptions { get; set; } = null!;

[Input("nodeSecurityGroupTags")]
private InputMap<string>? _nodeSecurityGroupTags;

/// <summary>
/// Tags attached to the security groups associated with the cluster's worker nodes.
/// </summary>
public InputMap<string> NodeSecurityGroupTags
{
get => _nodeSecurityGroupTags ?? (_nodeSecurityGroupTags = new InputMap<string>());
Expand All @@ -69,6 +89,10 @@ public InputMap<string> NodeSecurityGroupTags

[Input("privateSubnetIds")]
private InputList<string>? _privateSubnetIds;

/// <summary>
/// List of subnet IDs for the private subnets.
/// </summary>
public InputList<string> PrivateSubnetIds
{
get => _privateSubnetIds ?? (_privateSubnetIds = new InputList<string>());
Expand All @@ -80,6 +104,10 @@ public InputList<string> PrivateSubnetIds

[Input("publicSubnetIds")]
private InputList<string>? _publicSubnetIds;

/// <summary>
/// List of subnet IDs for the public subnets.
/// </summary>
public InputList<string> PublicSubnetIds
{
get => _publicSubnetIds ?? (_publicSubnetIds = new InputList<string>());
Expand All @@ -88,6 +116,10 @@ public InputList<string> PublicSubnetIds

[Input("storageClasses")]
private InputMap<Pulumi.Kubernetes.Storage.V1.StorageClass>? _storageClasses;

/// <summary>
/// The storage class used for persistent storage by the cluster.
/// </summary>
public InputMap<Pulumi.Kubernetes.Storage.V1.StorageClass> StorageClasses
{
get => _storageClasses ?? (_storageClasses = new InputMap<Pulumi.Kubernetes.Storage.V1.StorageClass>());
Expand All @@ -96,6 +128,10 @@ public InputMap<Pulumi.Kubernetes.Storage.V1.StorageClass> StorageClasses

[Input("subnetIds", required: true)]
private InputList<string>? _subnetIds;

/// <summary>
/// List of subnet IDs for the EKS cluster.
/// </summary>
public InputList<string> SubnetIds
{
get => _subnetIds ?? (_subnetIds = new InputList<string>());
Expand All @@ -104,15 +140,25 @@ public InputList<string> SubnetIds

[Input("tags")]
private InputMap<string>? _tags;

/// <summary>
/// A map of tags assigned to the EKS cluster.
/// </summary>
public InputMap<string> Tags
{
get => _tags ?? (_tags = new InputMap<string>());
set => _tags = value;
}

/// <summary>
/// The VPC CNI for the cluster.
/// </summary>
[Input("vpcCni")]
public Input<Pulumi.Eks.VpcCni>? VpcCni { get; set; }

/// <summary>
/// ID of the cluster's VPC.
/// </summary>
[Input("vpcId", required: true)]
public Input<string> VpcId { get; set; } = null!;

Expand Down
39 changes: 39 additions & 0 deletions sdk/dotnet/Outputs/CoreData.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,59 @@ public sealed class CoreData
public readonly Pulumi.Aws.Ec2.SecurityGroup ClusterSecurityGroup;
public readonly Pulumi.Kubernetes.Core.V1.ConfigMap? EksNodeAccess;
public readonly Pulumi.Aws.Eks.Outputs.ClusterEncryptionConfig? EncryptionConfig;
/// <summary>
/// The EKS cluster's Kubernetes API server endpoint.
/// </summary>
public readonly string Endpoint;
/// <summary>
/// The Fargate profile used to manage which pods run on Fargate.
/// </summary>
public readonly Pulumi.Aws.Eks.FargateProfile? FargateProfile;
/// <summary>
/// The IAM instance roles for the cluster's nodes.
/// </summary>
public readonly ImmutableArray<Pulumi.Aws.Iam.Role> InstanceRoles;
/// <summary>
/// The kubeconfig file for the cluster.
/// </summary>
public readonly object? Kubeconfig;
/// <summary>
/// The cluster's node group options.
/// </summary>
public readonly Outputs.ClusterNodeGroupOptions NodeGroupOptions;
/// <summary>
/// Tags attached to the security groups associated with the cluster's worker nodes.
/// </summary>
public readonly ImmutableDictionary<string, string>? NodeSecurityGroupTags;
public readonly Pulumi.Aws.Iam.OpenIdConnectProvider? OidcProvider;
/// <summary>
/// List of subnet IDs for the private subnets.
/// </summary>
public readonly ImmutableArray<string> PrivateSubnetIds;
public readonly Pulumi.Kubernetes.Provider Provider;
/// <summary>
/// List of subnet IDs for the public subnets.
/// </summary>
public readonly ImmutableArray<string> PublicSubnetIds;
/// <summary>
/// The storage class used for persistent storage by the cluster.
/// </summary>
public readonly ImmutableDictionary<string, Pulumi.Kubernetes.Storage.V1.StorageClass>? StorageClasses;
/// <summary>
/// List of subnet IDs for the EKS cluster.
/// </summary>
public readonly ImmutableArray<string> SubnetIds;
/// <summary>
/// A map of tags assigned to the EKS cluster.
/// </summary>
public readonly ImmutableDictionary<string, string>? Tags;
/// <summary>
/// The VPC CNI for the cluster.
/// </summary>
public readonly Pulumi.Eks.VpcCni? VpcCni;
/// <summary>
/// ID of the cluster's VPC.
/// </summary>
public readonly string VpcId;

[OutputConstructor]
Expand Down

0 comments on commit 347ae04

Please sign in to comment.