[Docs] FlyteRemote example throws an error

[davidmirror-ops]

Description

While runnning the FlyteRemote example locally, the result is the following error message:

_InactiveRpcError: <_InactiveRpcError of RPC that terminated with:
        status = StatusCode.INVALID_ARGUMENT
        details = "missing project"
        debug_error_string = "UNKNOWN:Error received from peer ipv4:127.0.0.1:30080 {created_time:"2023-11-02T05:53:05.142633-05:00", grpc_status:3, 
grpc_message:"missing project"}"

There's no reference to look further into FlyteRemote Config. A manual search leads to the FlyteRemote page but even adding explicitly the config like this:

remote = FlyteRemote(config= Config.for_endpoint(endpoint="localhost:30088", config_file="$HOME/.flyte/config.yaml"),default_project="flytesnacks",default_domain="development")

leads to an error:

FileNotFoundError: [Errno 2] No such file or directory: '$HOME/.flyte/config.yaml'

I'm sure there's something really simple I'm missing but it's nowhere explained in the docs.

Are you sure this issue hasn't been raised already?

• Yes

Have you read the Code of Conduct?

• Yes

[eapolinario]

can you confirm the version of flytekit ?

[davidmirror-ops]

Ok, I was using 1.9.1.

I just switched to 1.10. I'm running a sandbox cluster so I used this:

remote = FlyteRemote(config= Config.for_sandbox()) and it successfully fetches the config and connects to the sandbox cluster but still misses the default project/domain:

"UNKNOWN:Error received from peer ipv4:127.0.0.1:30080 {created_time:"2023-11-03T05:16:21.508258-05:00", grpc_status:3, grpc_message:"missing project"}"

Once I explicitly indicate it:

remote = FlyteRemote(config= Config.for_sandbox(),default_project="flytesnacks",default_domain="development")

It works.

I wasn't able to find how to indicate a default project/domain in the config file .

cc @samhita-alla do you think this is something we should add to the docs? Am I missing a step so FlyteRemote discovers the default project/domain?

[samhita-alla]

@davidmirror-ops, the default project and domain must be specified in the FlyteRemote config. Otherwise, you could also specify the project and domain during fetching or execution. Does that make sense?

[kumare3]

I think the error message should look better

[davidmirror-ops]

@samhita-alla It makes sense. The problem is that this is not mentioned in the example, but it's written so the reader understands that config.auto() will generate all the necessary config, including the project/domain.

[samhita-alla]

@davidmirror-ops, in that case, we need to update flyte remote docs.